ImmutableConfig (NeoEMF 2.0.0 API)

All Known Subinterfaces:

Config

All Known Implementing Classes:

BaseBlueprintsConfig, BaseConfig, BerkeleyDbConfig, BlueprintsNeo4jConfig, BlueprintsTinkerConfig, HBaseConfig, InMemoryConfig, MapDbConfig, MongoDbConfig
```
@ParametersAreNonnullByDefault
public interface ImmutableConfig
```
An immutable configuration that defines the behavior of BackendFactories and StoreFactory.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`getMapping()` Returns the defined mapping.
`String`	`getName()` Returns the name of the `BackendFactory` associated with this configuration.
`default <T> Optional<T>`	`getOption(String key)` Returns the value of the `key`.
`Map<String,?>`	`getOptions()` Returns all defined options.
`default Map<String,?>`	`getOptions(Predicate<String> keyFilter)` Returns a sub-map of all defined options filtered with the given `keyFilter`.
`Set<Store>`	`getStores()` Returns a set of all defined `Store`.
`String`	`getVariant()` Returns the variant of the `BackendFactory` binding.
`default boolean`	`hasOption(String key)` Returns `true` if the `key` is defined.
`default boolean`	`isReadOnly()` Returns `true` if the "read-only" mode is defined.
`void`	`save(Path directory)` Saves this configuration in the `directory`.
`Map<String,?>`	`toMap()` Returns a immutable map view of this configuration.

- Method Detail
  - save
```
void save(Path directory)
   throws IOException
```
    Saves this configuration in the directory.
    
    Parameters:
    
    directory - the directory where to store the configuration
    
    Throws:
    
    IOException - if an I/O error occurs during the saving
  - toMap
```
@Nonnull
Map<String,?> toMap()
```
    Returns a immutable map view of this configuration.
    
    Returns:
    
    an immutable map
    
    See Also:
    
    Resource.load(Map), Resource.save(Map)
  - getName
```
@Nonnull
String getName()
```
    Returns the name of the BackendFactory associated with this configuration.
    
    Returns:
    
    the name
    
    See Also:
    
    BackendFactory.name()
  - getVariant
```
@Nonnull
String getVariant()
```
    Returns the variant of the BackendFactory binding.
    
    Returns:
    
    the variant
  - getMapping
```
@Nonnull
String getMapping()
```
    Returns the defined mapping.
    
    Returns:
    
    the class name of the mapping
    
    Throws:
    
    InvalidConfigException - if the mapping is not defined
  - hasOption
```
default boolean hasOption(String key)
```
    Returns true if the key is defined.
    
    Parameters:
    
    key - the key to check the declaration
    
    Returns:
    
    true if the key is defined
  - getOption
```
default <T> Optional<T> getOption(String key)
```
    Returns the value of the key.
    
    Parameters:
    
    key - the key of the value
    
    Returns:
    
    a Optional containing the value, or Optional.empty() if the key is not defined
  - getOptions
```
@Nonnull
default Map<String,?> getOptions(Predicate<String> keyFilter)
```
    Returns a sub-map of all defined options filtered with the given keyFilter.
    
    Parameters:
    
    keyFilter - the predicate to filter the options
    
    Returns:
    
    an immutable map of the options that match the keyFilter
  - getOptions
```
@Nonnull
Map<String,?> getOptions()
```
    Returns all defined options.
    
    Returns:
    
    an immutable map
  - getStores
```
@Nonnull
Set<Store> getStores()
```
    Returns a set of all defined Store.
    
    Returns:
    
    an immutable collection of stores declaration
  - isReadOnly
```
default boolean isReadOnly()
```
    Returns true if the "read-only" mode is defined.
    
    Returns:
    
    true if the "read-only" mode is defined

Interface ImmutableConfig

Method Summary

Method Detail

save

toMap

getName

getVariant

getMapping

hasOption

getOption

getOptions

getOptions

getStores

isReadOnly