fr.inria.atlanmod.neoemf.option

Class AbstractPersistenceOptionsBuilder<B extends AbstractPersistenceOptionsBuilder<B,O>,O extends AbstractPersistenceOptions>

java.lang.Object

fr.inria.atlanmod.neoemf.option.AbstractPersistenceOptionsBuilder<B,O>

Type Parameters:

B - the "self"-type of this PersistenceOptionsBuilder

O - the type of PersistenceOptions built by this builder

All Implemented Interfaces:

PersistenceOptionsBuilder

Direct Known Subclasses:

AbstractBlueprintsOptionsBuilder, CommonOptionsBuilder, HBaseOptionsBuilder, MapDbOptionsBuilder

public abstract class AbstractPersistenceOptionsBuilder<B extends AbstractPersistenceOptionsBuilder<B,O>,O extends AbstractPersistenceOptions>
extends Object
implements PersistenceOptionsBuilder

An abstract PersistenceOptionsBuilder that manages the assembly and the construction of PersistenceOptions.

All features are all optional: options can be created using all or none of them.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPersistenceOptionsBuilder() Constructs a new AbstractPersistenceOptionsBuilder.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns an immutable Map containing all defined options.
B	cacheFeatures() Adds the cache-features feature in the created options.
B	cacheIsSet() Adds the cache-is-set feature in the created options.
B	cacheSizes() Adds the cache-sizes feature in the created options.
B	countLoadedObjects() Adds the count-loaded-objects feature in the created options.
B	log() Adds the log feature in the created options.
static Map<String,Object>	noOption() Returns an immutable empty Map.
B	option(String key, Object value) Adds a key/value in the created options.
protected B	storeOption(PersistentStoreOptions storeOption) Adds a feature defined by the given storeOption in the created options.
protected void	validate() Validates the defined options, and checks if there is conflict between them.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPersistenceOptionsBuilder

protected AbstractPersistenceOptionsBuilder()

Constructs a new AbstractPersistenceOptionsBuilder.

Method Detail

noOption

@Nonnull
public static Map<String,Object> noOption()

Returns an immutable empty Map.

Returns:

an immutable Map

asMap

@Nonnull
public final Map<String,Object> asMap()
                                         throws InvalidOptionException

Description copied from interface: PersistenceOptionsBuilder

Returns an immutable Map containing all defined options.

Specified by:

asMap in interface PersistenceOptionsBuilder

Returns:

an immutable Map

Throws:

InvalidOptionException - if a conflict is detected during building

validate

protected void validate()
                 throws InvalidOptionException

Validates the defined options, and checks if there is conflict between them.

Throws:

InvalidOptionException - if a conflict is detected

storeOption

protected B storeOption(PersistentStoreOptions storeOption)

Adds a feature defined by the given storeOption in the created options.

Parameters:

storeOption - the option to add

Returns:

this builder (for chaining)

option

public B option(String key,
                Object value)

Adds a key/value in the created options. A custom configuration, which is not part of NeoEMF, can be added.

Parameters:

key - the key to add

value - the value of the key

Returns:

this builder (for chaining)

cacheIsSet

public B cacheIsSet()

Adds the cache-is-set feature in the created options.

Returns:

this builder (for chaining)

See Also:

IsSetCachingStoreDecorator

cacheSizes

public B cacheSizes()

Adds the cache-sizes feature in the created options.

Returns:

this builder (for chaining)

See Also:

SizeCachingStoreDecorator

cacheFeatures

public B cacheFeatures()

Adds the cache-features feature in the created options.

Returns:

this builder (for chaining)

See Also:

FeatureCachingStoreDecorator

log

public B log()

Adds the log feature in the created options.

Returns:

this builder (for chaining)

See Also:

LoggingStoreDecorator

countLoadedObjects

public B countLoadedObjects()

Adds the count-loaded-objects feature in the created options.

Returns:

this builder (for chaining)

See Also:

LoadedObjectCounterStoreDecorator