Package com.atlassian.bamboo.persister.xstream

Class AbstractXStreamPersister<K extends Key,V>

java.lang.Object

com.atlassian.bamboo.persister.xstream.AbstractXStreamPersister<K,V>

All Implemented Interfaces:

XStreamObjectPersister<K,V>

Direct Known Subclasses:

XStreamChainStatePersisterImpl, XStreamCurrentlyBuildingPersisterImpl, XStreamDeploymentInProgressPersisterImpl, XStreamSecureTokenPersister

public abstract class AbstractXStreamPersister<K extends Key,V>
extends Object
implements XStreamObjectPersister<K,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractXStreamPersister(com.thoughtworks.xstream.XStream xStream, Supplier<File> storageDirectorySupplier, Function<? super V,K> keyGenerator, Class<V> persistedClass)

Method Summary

Modifier and Type	Method	Description
void	cleanStorage()	Remove all persisted objects
V	load(K key)	Load object from the storage
List<Pair<K,V>>	loadAll()	Loads all stored objects.
@NotNull List<Pair<K,V>>	loadAndRemoveAll()	Loads all stored objects and removes files from storage.
void	remove(K key)	Remove object identified by key from the storage
void	save(V objectToBePersisted, boolean saveEvenIfFileExists)	Save an object in the storage
protected File	storageFile(K key)	Create storage file for persisting object
protected File	temporaryFile(K key)	Create temporary file for persisting object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractXStreamPersister

protected AbstractXStreamPersister(com.thoughtworks.xstream.XStream xStream,
                                   Supplier<File> storageDirectorySupplier,
                                   Function<? super V,K> keyGenerator,
                                   Class<V> persistedClass)

Method Detail

load

@NotNull
public V load(@NotNull
              K key)

Description copied from interface: XStreamObjectPersister

Load object from the storage

Specified by:

load in interface XStreamObjectPersister<K extends Key,V>

Returns:

object fetched from the storage

save

public void save(@NotNull
                 V objectToBePersisted,
                 boolean saveEvenIfFileExists)

Description copied from interface: XStreamObjectPersister

Save an object in the storage

Specified by:

save in interface XStreamObjectPersister<K extends Key,V>

remove

public void remove(@NotNull
                   K key)

Description copied from interface: XStreamObjectPersister

Remove object identified by key from the storage

Specified by:

remove in interface XStreamObjectPersister<K extends Key,V>

cleanStorage

public void cleanStorage()

Description copied from interface: XStreamObjectPersister

Remove all persisted objects

Specified by:

cleanStorage in interface XStreamObjectPersister<K extends Key,V>

loadAndRemoveAll

@NotNull
public @NotNull List<Pair<K,V>> loadAndRemoveAll()

Description copied from interface: XStreamObjectPersister

Loads all stored objects and removes files from storage.

Specified by:

loadAndRemoveAll in interface XStreamObjectPersister<K extends Key,V>

temporaryFile

protected File temporaryFile(@NotNull
                             K key)

Create temporary file for persisting object

storageFile

protected File storageFile(@NotNull
                           K key)

Create storage file for persisting object

loadAll

public List<Pair<K,V>> loadAll()

Description copied from interface: XStreamObjectPersister

Loads all stored objects.

Specified by:

loadAll in interface XStreamObjectPersister<K extends Key,V>