org.refcodes.configuration

Interface ResourceProperties.ResourcePropertiesBuilder

All Superinterfaces:

org.refcodes.structure.CanonicalMap, org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap, org.refcodes.structure.Clearable, org.refcodes.structure.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.structure.Dictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary<String,String>, org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>, org.refcodes.mixin.Dumpable, Flushable, org.refcodes.structure.Keys<String,String>, org.refcodes.structure.Keys.MutableKeys<String,String>, org.refcodes.structure.Keys.MutableValues<String,String>, Map<String,String>, org.refcodes.structure.PathMap<String>, org.refcodes.structure.PathMap.MutablePathMap<String>, org.refcodes.structure.PathMap.PathMapBuilder<String>, Properties, Properties.MutableProperties, Properties.PropertiesBuilder, org.refcodes.structure.PropertiesAccessorMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin, ResourceProperties, ResourceProperties.MutableResourcProperties, org.refcodes.mixin.TypeAccessor<String>

All Known Implementing Classes:

AbstractResourcePropertiesBuilder, JavaPropertiesBuilderImpl, JsonPropertiesBuilderImpl, TomlPropertiesBuilderImpl, XmlPropertiesBuilderImpl, YamlPropertiesBuilderImpl

Enclosing interface:

ResourceProperties

public static interface ResourceProperties.ResourcePropertiesBuilder
extends Properties.PropertiesBuilder, ResourceProperties.MutableResourcProperties

The interface ResourceProperties.ResourcePropertiesBuilder defines builder functionality on top of the properties .

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.configuration.ResourceProperties

ResourceProperties.MutableResourcProperties, ResourceProperties.ResourcePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.configuration.Properties

Properties.MutableProperties, Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

org.refcodes.structure.PathMap.MutablePathMap<T>, org.refcodes.structure.PathMap.PathMapBuilder<T>

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary.MutableDictionary

org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

org.refcodes.structure.Dictionary.MutableDictionary<K,V>

Field Summary

Fields inherited from interface org.refcodes.configuration.ResourceProperties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method and Description
default ResourceProperties.ResourcePropertiesBuilder	retrieve(String aFromPath, String aToPath)
ResourceProperties.ResourcePropertiesBuilder	retrieveFrom(String aFromPath)
ResourceProperties.ResourcePropertiesBuilder	retrieveTo(String aToPath)
default ResourceProperties.ResourcePropertiesBuilder	withInsert(Object aObj)
default ResourceProperties.ResourcePropertiesBuilder	withInsert(String aToPath, Object aFrom, String aFromPath)
default ResourceProperties.ResourcePropertiesBuilder	withInsertFrom(Object aFrom, String aFromPath)
default ResourceProperties.ResourcePropertiesBuilder	withInsertTo(String aToPath, Object aFrom)
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(Class<?> aResourceClass, String aFilePath) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(Class, String).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(Class<?> aResourceClass, String aFilePath, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(Class, String, char...).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(File aFile) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(File).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(File aFile, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(File, char...).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(InputStream aInputStream) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(InputStream aInputStream, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(String aFilePath) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(String aFilePath, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String, char...).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(URL aUrl) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(URL).
default ResourceProperties.ResourcePropertiesBuilder	withLoadFrom(URL aUrl, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withPut(org.refcodes.structure.Relation<String,String> aProperty)
default ResourceProperties.ResourcePropertiesBuilder	withPut(String aKey, String aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutBoolean(String aKey, Boolean aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutByte(String aKey, Byte aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutDouble(String aKey, Double aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutFloat(String aKey, Float aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutInteger(String aKey, Integer aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutLong(String aKey, Long aValue)
default ResourceProperties.ResourcePropertiesBuilder	withPutShort(String aKey, Short aValue)
default ResourceProperties.ResourcePropertiesBuilder	withRemoveFrom(String aPath)
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(Class<?> aResourceClass, String aFilePath) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(Class<?> aResourceClass, String aFilePath, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(File aFile) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(File aFile, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(String aFilePath) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).
default ResourceProperties.ResourcePropertiesBuilder	withSeekFrom(String aFilePath, char... aDelimiters) Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin

withPut

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Methods inherited from interface org.refcodes.configuration.ResourceProperties.MutableResourcProperties

loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, loadFrom, parseFrom, parseFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom, seekFrom

Methods inherited from interface org.refcodes.configuration.ResourceProperties

saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, saveTo, toSerialized, toSerialized

Methods inherited from interface java.io.Flushable

flush

Methods inherited from interface org.refcodes.configuration.Properties.MutableProperties

containsValue, delete, put, putAll, putAll, putAll

Methods inherited from interface org.refcodes.configuration.Properties

getType, toMap, toProperties, toPropertyPath

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

putAll, toDump, toSourceCode

Methods inherited from interface org.refcodes.structure.CanonicalMap

toType, toType

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

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

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

insert, insert, insertFrom, insertTo, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, fromExternalKey, getArray, getArray, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toRootPath

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Method Detail

withPut

default ResourceProperties.ResourcePropertiesBuilder withPut(String aKey,
                                                             String aValue)

Specified by:

withPut in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>

Specified by:

withPut in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withPut in interface Properties.PropertiesBuilder

Specified by:

withPut in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPut

default ResourceProperties.ResourcePropertiesBuilder withPut(org.refcodes.structure.Relation<String,String> aProperty)

Specified by:

withPut in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPut in interface org.refcodes.structure.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.PathMap.PathMapBuilder<String>>

Specified by:

withPut in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withPut in interface Properties.PropertiesBuilder

withPutInteger

default ResourceProperties.ResourcePropertiesBuilder withPutInteger(String aKey,
                                                                    Integer aValue)

Specified by:

withPutInteger in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutInteger in interface Properties.PropertiesBuilder

Specified by:

withPutInteger in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutShort

default ResourceProperties.ResourcePropertiesBuilder withPutShort(String aKey,
                                                                  Short aValue)

Specified by:

withPutShort in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutShort in interface Properties.PropertiesBuilder

Specified by:

withPutShort in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutByte

default ResourceProperties.ResourcePropertiesBuilder withPutByte(String aKey,
                                                                 Byte aValue)

Specified by:

withPutByte in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutByte in interface Properties.PropertiesBuilder

Specified by:

withPutByte in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutDouble

default ResourceProperties.ResourcePropertiesBuilder withPutDouble(String aKey,
                                                                   Double aValue)

Specified by:

withPutDouble in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutDouble in interface Properties.PropertiesBuilder

Specified by:

withPutDouble in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutFloat

default ResourceProperties.ResourcePropertiesBuilder withPutFloat(String aKey,
                                                                  Float aValue)

Specified by:

withPutFloat in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutFloat in interface Properties.PropertiesBuilder

Specified by:

withPutFloat in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutBoolean

default ResourceProperties.ResourcePropertiesBuilder withPutBoolean(String aKey,
                                                                    Boolean aValue)

Specified by:

withPutBoolean in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutBoolean in interface Properties.PropertiesBuilder

Specified by:

withPutBoolean in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withPutLong

default ResourceProperties.ResourcePropertiesBuilder withPutLong(String aKey,
                                                                 Long aValue)

Specified by:

withPutLong in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withPutLong in interface Properties.PropertiesBuilder

Specified by:

withPutLong in interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder>

withInsert

default ResourceProperties.ResourcePropertiesBuilder withInsert(Object aObj)

Specified by:

withInsert in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withInsert in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withInsert in interface Properties.PropertiesBuilder

withInsertFrom

default ResourceProperties.ResourcePropertiesBuilder withInsertFrom(Object aFrom,
                                                                    String aFromPath)

Specified by:

withInsertFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withInsertFrom in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withInsertFrom in interface Properties.PropertiesBuilder

withInsertTo

default ResourceProperties.ResourcePropertiesBuilder withInsertTo(String aToPath,
                                                                  Object aFrom)

Specified by:

withInsertTo in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withInsertTo in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withInsertTo in interface Properties.PropertiesBuilder

withInsert

default ResourceProperties.ResourcePropertiesBuilder withInsert(String aToPath,
                                                                Object aFrom,
                                                                String aFromPath)

Specified by:

withInsert in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withInsert in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withInsert in interface Properties.PropertiesBuilder

withRemoveFrom

default ResourceProperties.ResourcePropertiesBuilder withRemoveFrom(String aPath)

Specified by:

withRemoveFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

withRemoveFrom in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

withRemoveFrom in interface Properties.PropertiesBuilder

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(String aFilePath)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aFilePath - The according file path.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(Class<?> aResourceClass,
                                                                  String aFilePath)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(Class, String).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(String aFilePath,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String, char...).

Parameters:

aFilePath - The according file path.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(Class<?> aResourceClass,
                                                                  String aFilePath,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(Class, String, char...).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(File aFile)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(File).

Parameters:

aFile - The according file.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(File aFile,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(File, char...).

Parameters:

aFile - The according file path.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(URL aUrl)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(URL).

Parameters:

aUrl - The URL from which to load the properties.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(URL aUrl,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aUrl - The URL from which to load the properties.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(InputStream aInputStream)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aInputStream - The InputStream from which to load the properties.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withLoadFrom

default ResourceProperties.ResourcePropertiesBuilder withLoadFrom(InputStream aInputStream,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aInputStream - The InputStream from which to load the properties.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(File aFile)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aFile - The according file path.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(File aFile,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aDelimiters - The according delimiters.

aFile - The according file path.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(String aFilePath)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aFilePath - The according file path.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(Class<?> aResourceClass,
                                                                  String aFilePath)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(String aFilePath,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aFilePath - The according file.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

withSeekFrom

default ResourceProperties.ResourcePropertiesBuilder withSeekFrom(Class<?> aResourceClass,
                                                                  String aFilePath,
                                                                  char... aDelimiters)
                                                           throws IOException,
                                                                  ParseException

Builder method for ResourceProperties.MutableResourcProperties.loadFrom(String).

Parameters:

aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).

aFilePath - The file path of the class's resources from which to load the properties.

aDelimiters - The according delimiters.

Returns:

The implementing instance as of the builder pattern.

Throws:

IOException - thrown in case accessing or processing the properties file failed.

ParseException - Signals that an error has been reached unexpectedly while parsing the data to be loaded.

retrieveFrom

ResourceProperties.ResourcePropertiesBuilder retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

retrieveFrom in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

retrieveFrom in interface org.refcodes.structure.PathMap<String>

Specified by:

retrieveFrom in interface org.refcodes.structure.PathMap.MutablePathMap<String>

Specified by:

retrieveFrom in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

retrieveFrom in interface Properties

Specified by:

retrieveFrom in interface Properties.MutableProperties

Specified by:

retrieveFrom in interface Properties.PropertiesBuilder

Specified by:

retrieveFrom in interface ResourceProperties

Specified by:

retrieveFrom in interface ResourceProperties.MutableResourcProperties

retrieveTo

ResourceProperties.ResourcePropertiesBuilder retrieveTo(String aToPath)

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

retrieveTo in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

retrieveTo in interface org.refcodes.structure.PathMap<String>

Specified by:

retrieveTo in interface org.refcodes.structure.PathMap.MutablePathMap<String>

Specified by:

retrieveTo in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

retrieveTo in interface Properties

Specified by:

retrieveTo in interface Properties.MutableProperties

Specified by:

retrieveTo in interface Properties.PropertiesBuilder

Specified by:

retrieveTo in interface ResourceProperties

Specified by:

retrieveTo in interface ResourceProperties.MutableResourcProperties

retrieve

default ResourceProperties.ResourcePropertiesBuilder retrieve(String aFromPath,
                                                              String aToPath)

Specified by:

retrieve in interface org.refcodes.structure.CanonicalMap.CanonicalMapBuilder

Specified by:

retrieve in interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

Specified by:

retrieve in interface org.refcodes.structure.PathMap<String>

Specified by:

retrieve in interface org.refcodes.structure.PathMap.MutablePathMap<String>

Specified by:

retrieve in interface org.refcodes.structure.PathMap.PathMapBuilder<String>

Specified by:

retrieve in interface Properties

Specified by:

retrieve in interface Properties.MutableProperties

Specified by:

retrieve in interface Properties.PropertiesBuilder

Specified by:

retrieve in interface ResourceProperties

Specified by:

retrieve in interface ResourceProperties.MutableResourcProperties