org.refcodes.structure.CanonicalMap
, org.refcodes.structure.Containable
, org.refcodes.mixin.DelimiterAccessor
, org.refcodes.structure.Dictionary<String,T>
, org.refcodes.mixin.Dumpable
, org.refcodes.structure.Keys<String,T>
, org.refcodes.structure.PathMap<String>
, Properties
, org.refcodes.structure.PropertiesAccessorMixin
, org.refcodes.mixin.TypeAccessor<String>
ResourceProperties.MutableResoureProperties
, ResourceProperties.ResourcePropertiesBuilder
, ScheduledResourceProperties
, ScheduledResourceProperties.ScheduledMuableResourceProperties
, ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
AbstractResourcePropertiesBuilder
, AbstractResourcePropertiesBuilderDecorator
, AbstractResourcePropertiesDecorator
, JavaProperties
, JavaPropertiesBuilder
, JsonProperties
, JsonPropertiesBuilder
, ScheduledResourcePropertiesBuilderDecorator
, ScheduledResourcePropertiesDecorator
, TomlProperties
, TomlPropertiesBuilder
, XmlProperties
, XmlPropertiesBuilder
, YamlProperties
, YamlPropertiesBuilder
public interface ResourceProperties extends Properties
ResourceProperties
are a specialization of the
Dictionary
. Properties represent a collection of String
key
and String
value pairs as properties usually occur in pure text form,
to be converted to the required data types. For this reason, the
ResourceProperties
interface provides additional conversion methods.Modifier and Type | Interface | Description |
---|---|---|
static interface |
ResourceProperties.MutableResoureProperties |
The interface
ResourceProperties.MutableResoureProperties defines "dirty" methods
allowing to modify ("mutate") the ResourceProperties . |
static interface |
ResourceProperties.ResourcePropertiesBuilder |
The interface
ResourceProperties.ResourcePropertiesBuilder defines builder
functionality on top of the ResourceProperties.MutableResoureProperties . |
org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap
org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty
org.refcodes.structure.Dictionary.MutableDictionary<K extends Object,V extends Object>
org.refcodes.structure.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.structure.Keys.MutableValues<K extends Object,V extends Object>
org.refcodes.structure.PathMap.MutablePathMap<T extends Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends Object>
Properties.MutableProperties, Properties.PropertiesBuilder
org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
DEFAULT_COMMENT
Modifier and Type | Method | Description |
---|---|---|
Properties |
reload() |
Reloads the
ResourceProperties from the resource to which the
ResourceProperties are attached to (such as a File as of
ResourceProperties.MutableResoureProperties.loadFrom(File) or
ResourceProperties.MutableResoureProperties.saveTo(File) ). |
Properties |
reload(ReloadMode aReloadMode) |
Reloads the
ResourceProperties from the resource to which the
ResourceProperties are attached to (such as a File as of
ResourceProperties.MutableResoureProperties.loadFrom(File) or
ResourceProperties.MutableResoureProperties.saveTo(File) ). |
toInstance, toInstance, toType, toType
containsKey, get, get, keySet, use, values
directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath
childrenOf, containsValue, getDelimiter, getType, retrieve, retrieveFrom, retrieveTo, toMap, toProperties, toPropertyPath
containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort
Properties reload() throws IOException, IllegalStateException, ParseException
ResourceProperties
from the resource to which the
ResourceProperties
are attached to (such as a File
as of
ResourceProperties.MutableResoureProperties.loadFrom(File)
or
ResourceProperties.MutableResoureProperties.saveTo(File)
).
In case the resource (such as an InputStream
) does not support
reloading, then an IllegalStateException
is thrown.
Properties existing in the attached resource as well in the
Properties
itself are replaced. Properties existing in the
attached resource but not(!) in the Properties
itself are not(!)
removed. Use reload(ReloadMode)
with an argument of
true
(~ orphan removal) to remove properties not existing in
the resource.Properties
as loaded from the resource and applied to
this instance.IOException
- thrown in case accessing the resource encountered an
I/O problem.IllegalStateException
- in case the attached resource does not
support reloading.ParseException
- Signals that an error has been reached
unexpectedly while parsing the data to be loaded.Properties reload(ReloadMode aReloadMode) throws IOException, IllegalStateException, ParseException
ResourceProperties
from the resource to which the
ResourceProperties
are attached to (such as a File
as of
ResourceProperties.MutableResoureProperties.loadFrom(File)
or
ResourceProperties.MutableResoureProperties.saveTo(File)
).
In case the resource (such as an InputStream
) does not support
reloading, then an IllegalStateException
is thrown.
Properties existing in the attached resource as well in the
Properties
itself are replaced.
When "orphan removal" is set to false
, then properties
existing in the attached resource but not(!) in the Properties
itself are not(!) removed. When "orphan removal" is set to
true
, then properties existing in the attached resource but
not(!) in the Properties
itself are(!) removed.aReloadMode
- when set to ReloadMode.ORPHAN_REMOVAL
, then
properties existing in the attached resource but not(!) in the
Properties
itself are(!) removed. Else properties not
existing in the attached resource are kept.Properties
as loaded from the resource and applied to
this instance.IOException
- thrown in case accessing the resource encountered an
I/O problem.IllegalStateException
- in case the attached resource does not
support reloading.ParseException
- Signals that an error has been reached
unexpectedly while parsing the data to be loaded.Copyright © 2018. All rights reserved.