Package org.apache.juneau.config.store
Class ClasspathStore
java.lang.Object
org.apache.juneau.Context
org.apache.juneau.config.store.ConfigStore
org.apache.juneau.config.store.ClasspathStore
- All Implemented Interfaces:
Closeable
,AutoCloseable
,AnnotationProvider
Classpath-based storage location for configuration files.
Looks inside the JVM classpath for configuration files.
Configuration files retrieved from the classpath can be modified but not persisted.
Notes:
- This class is thread safe and reusable.
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ClasspathStore
Default memory store, all default values.Fields inherited from class org.apache.juneau.Context
CONTEXT_APPLY_FILTER
Fields inherited from interface org.apache.juneau.AnnotationProvider
DISABLE_ANNOTATION_CACHING
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
No-op.copy()
Creates a builder from this context object.static ClasspathStore.Builder
create()
Creates a new builder for this object.boolean
Checks whether the configuration with the specified name exists in this store.Returns the contents of the configuration file.Called when the physical contents of a config file have changed.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
getMap, register, resolveName, unregister, update
Methods inherited from class org.apache.juneau.Context
createBuilder, createSession, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, getSession, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, properties, toString
-
Field Details
-
DEFAULT
Default memory store, all default values.
-
-
Constructor Details
-
ClasspathStore
Constructor.- Parameters:
builder
- The builder for this object.
-
-
Method Details
-
create
Creates a new builder for this object.- Returns:
- A new builder.
-
copy
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.
-
read
Description copied from class:ConfigStore
Returns the contents of the configuration file.- Specified by:
read
in classConfigStore
- Parameters:
name
- The config file name.- Returns:
- The contents of the configuration file.
A blank string if the config does not exist.
Nevernull . - Throws:
IOException
- Thrown by underlying stream.
-
write
Description copied from class:ConfigStore
Saves the contents of the configuration file if the underlying storage hasn't been modified.- Specified by:
write
in classConfigStore
- 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. - Throws:
IOException
- Thrown by underlying stream.
-
exists
Description copied from class:ConfigStore
Checks whether the configuration with the specified name exists in this store.- Specified by:
exists
in classConfigStore
- Parameters:
name
- The config name.- Returns:
true if the configuration with the specified name exists in this store.
-
update
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 classConfigStore
- Parameters:
name
- The config name (e.g. the filename without the extension).newContents
- The new contents.- Returns:
- This object.
-
close
No-op.- Throws:
IOException
-