org.apache.juneau.config.store

Class ConfigMemoryStore

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.config.store.ConfigStore

org.apache.juneau.config.store.ConfigMemoryStore

All Implemented Interfaces:

Closeable, AutoCloseable

@ConfigurableContext
public class ConfigMemoryStore
extends ConfigStore

Filesystem-based storage location for configuration files.

Points to a file system directory containing configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigMemoryStore	DEFAULT Default memory store, all default values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigMemoryStore(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
ConfigMemoryStoreBuilder	builder() Creates a builder from this context object.
void	close() No-op.
static ConfigMemoryStoreBuilder	create() Create a new builder for this object.
boolean	exists(String name) Checks whether the configuration with the specified name exists in this store.
String	read(String name) Returns the contents of the configuration file.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.
ConfigMemoryStore	update(String name, String newContents) Called when the physical contents of a config file have changed.
String	write(String name, String expectedContents, String newContents) Saves the contents of the configuration file if the underlying storage hasn't been modified.

Methods inherited from class org.apache.juneau.config.store.ConfigStore

createDefaultSessionArgs, createSession, getMap, register, resolveName, unregister, update

Methods inherited from class org.apache.juneau.Context

createSession, equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final ConfigMemoryStore DEFAULT

Default memory store, all default values.

Constructor Detail

ConfigMemoryStore

protected ConfigMemoryStore(PropertyStore ps)

Constructor.

Parameters:

ps - The settings for this content store.

Method Detail

create

public static ConfigMemoryStoreBuilder create()

Create a new builder for this object.

Returns:

A new builder for this object.

builder

public ConfigMemoryStoreBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Context

Returns:

A new ContextBuilder object.

read

public String read(String name)

Description copied from class: ConfigStore

Returns the contents of the configuration file.

Specified by:

read in class ConfigStore

Parameters:

name - The config file name.

Returns:

The contents of the configuration file.
A blank string if the config does not exist.
Never null.

write

public String write(String name,
                    String expectedContents,
                    String newContents)

Description copied from class: ConfigStore

Saves the contents of the configuration file if the underlying storage hasn't been modified.

Specified by:

write in class ConfigStore

Parameters:

name - The config file name.

expectedContents - The expected contents of the file.

newContents - The new contents.

Returns:

If null, then we successfully stored the contents of the file.
Otherwise the contents of the file have changed and we return the new contents of the file.

exists

public boolean exists(String name)

Description copied from class: ConfigStore

Checks whether the configuration with the specified name exists in this store.

Specified by:

exists in class ConfigStore

Parameters:

name - The config name.

Returns:

true if the configuration with the specified name exists in this store.

update

public ConfigMemoryStore update(String name,
                                String newContents)

Description copied from class: ConfigStore

Called when the physical contents of a config file have changed.

Triggers calls to ConfigStoreListener.onChange(String) on all registered listeners.

Overrides:

update in class ConfigStore

Parameters:

name - The config name (e.g. the filename without the extension).

newContents - The new contents.

Returns:

This object (for method chaining).

close

public void close()
           throws IOException

No-op.

Throws:

IOException

toMap

public ObjectMap toMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class ConfigStore

Returns:

A new map containing the properties defined on this context.