public class PropertiesSugar extends Object
Properties
precedences using ProfilePropertiesDecorator
,
ProfilePropertiesProjection
, ResourceProperties
or
PropertiesPrecedenceComposite
(and the like).Constructor | Description |
---|---|
PropertiesSugar() |
Modifier and Type | Method | Description |
---|---|---|
static ResourceProperties.ResourcePropertiesBuilder |
fileToJavaProperties(Properties aProperties,
File aFile) |
Files the Java properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
fileToJavaProperties(Properties aProperties,
String aFilePath) |
Files the Java properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
fileToJsonProperties(Properties aProperties,
File aFile) |
Files the JSON properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
fileToJsonProperties(Properties aProperties,
String aFilePath) |
Files the JSON properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
fileToTomlProperties(Properties aProperties,
File aFile) |
Files the TOML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
fileToTomlProperties(Properties aProperties,
String aFilePath) |
Files the TOML properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
fileToXmlProperties(Properties aProperties,
File aFile) |
Files the XML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
fileToXmlProperties(Properties aProperties,
String aFilePath) |
Files the XML properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
fileToYamlProperties(Properties aProperties,
File aFile) |
Files the YAML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
fileToYamlProperties(Properties aProperties,
String aFilePath) |
Files the YAML properties to the given file's path.
|
static org.refcodes.structure.Property |
from(String aKey,
String aValue) |
Deprecated.
Implemented to see how it feels like using it in my sources
|
static Properties.PropertiesBuilder |
from(org.refcodes.structure.Property... aProperties) |
Deprecated.
Implemented to see how it feels like using it in my sources
|
static Properties |
fromEnvironmentVariables() |
Returns
Properties representing the operating system's
environment variables as of env on Linux or Unix shells or
set on Windows machines. |
static Properties |
fromProfile(Properties aProperties) |
Wraps the
Properties with a profile projection. |
static Properties |
fromProfile(Properties aProperties,
String... aProfiles) |
Wraps the
Properties with a profile projection. |
static Properties.PropertiesBuilder |
fromProperties(org.refcodes.structure.Property... aProperties) |
Creates a
Properties instance from the provided Property
instances. |
static Properties |
fromSystemProperties() |
Returns
Properties representing the system properties as passed
via the "-Dkey=value" when launching the JVM (e.g.java
-Dconsole.width=220). |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJavaProperties(File aFile) |
Loads the Java properties from the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJavaProperties(InputStream aInputStream) |
Reads the properties from the given
InputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJavaProperties(String aFilePath) |
Loads the Java properties from the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJavaProperties(URL aUrl) |
Loads the Java properties from the given
URL . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJsonProperties(File aFile) |
Loads the JSON properties from the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJsonProperties(InputStream aInputStream) |
Reads the properties from the given
InputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJsonProperties(String aFilePath) |
Loads the JSON properties from the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
loadFromJsonProperties(URL aUrl) |
Loads the JSON properties from the given
URL . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromTomlProperties(File aFile) |
Loads the TOML properties from the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromTomlProperties(InputStream aInputStream) |
Reads the properties from the given
InputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromTomlProperties(String aFilePath) |
Loads the TOML properties from the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
loadFromTomlProperties(URL aUrl) |
Loads the TOML properties from the given
URL . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromXmlProperties(File aFile) |
Loads the XML properties from the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromXmlProperties(InputStream aInputStream) |
Reads the properties from the given
InputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromXmlProperties(String aFilePath) |
Loads the XML properties from the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
loadFromXmlProperties(URL aUrl) |
Loads the XML properties from the given
URL . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromYamlProperties(File aFile) |
Loads the YAML properties from the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromYamlProperties(InputStream aInputStream) |
Reads the properties from the given
InputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
loadFromYamlProperties(String aFilePath) |
Loads the YAML properties from the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
loadFromYamlProperties(URL aUrl) |
Loads the YAML properties from the given
URL . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToJavaProperties(Properties aProperties,
File aFile) |
Saves the Java properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToJavaProperties(Properties aProperties,
OutputStream aOutputStream) |
Writes the properties to the given
OutputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToJavaProperties(Properties aProperties,
String aFilePath) |
Saves the Java properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
saveToJsonProperties(Properties aProperties,
File aFile) |
Saves the JSON properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToJsonProperties(Properties aProperties,
OutputStream aOutputStream) |
Writes the properties to the given
OutputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToJsonProperties(Properties aProperties,
String aFilePath) |
Saves the JSON properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
saveToTomlProperties(Properties aProperties,
File aFile) |
Saves the TOML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToTomlProperties(Properties aProperties,
OutputStream aOutputStream) |
Writes the properties to the given
OutputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToTomlProperties(Properties aProperties,
String aFilePath) |
Saves the TOML properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
saveToXmlProperties(Properties aProperties,
File aFile) |
Saves the XML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToXmlProperties(Properties aProperties,
OutputStream aOutputStream) |
Writes the properties to the given
OutputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToXmlProperties(Properties aProperties,
String aFilePath) |
Saves the XML properties to the given file's path.
|
static ResourceProperties.ResourcePropertiesBuilder |
saveToYamlProperties(Properties aProperties,
File aFile) |
Saves the YAML properties to the given
File . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToYamlProperties(Properties aProperties,
OutputStream aOutputStream) |
Writes the properties to the given
OutputStream . |
static ResourceProperties.ResourcePropertiesBuilder |
saveToYamlProperties(Properties aProperties,
String aFilePath) |
Saves the YAML properties to the given file's path.
|
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with default settings being a poll loop time
of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of
ResourceProperties.reload(ReloadMode) being called with
ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with default settings being a
poll loop time of 10 seconds (as of PollLoopTime.NORM ) and orphan
removal (as of ResourceProperties.reload(ReloadMode) being called
with ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
int aScheduleTimeInMillis) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the given poll
loop time and orphan removal (as of
ResourceProperties.reload(ReloadMode) being called with
ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
int aScheduleTimeInMillis,
ReloadMode aReloadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the given poll
loop time and the given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
int aScheduleTimeInMillis,
ReloadMode aReloadMode,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the given poll
loop time and the given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
int aScheduleTimeInMillis,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the given poll
loop time and orphan removal (as of
ResourceProperties.reload(ReloadMode) being called with
ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
ReloadMode aReloadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the the default
poll loop time of 10 seconds (as of PollLoopTime.NORM ) and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
ReloadMode aReloadMode,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with setting the the default
poll loop time of 10 seconds (as of PollLoopTime.NORM ) and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder |
schedule(ResourceProperties.ResourcePropertiesBuilder aProperties,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesBuilderDecorator wrapping
the given ResourceProperties.ResourcePropertiesBuilder with default settings being a
poll loop time of 10 seconds (as of PollLoopTime.NORM ) and orphan
removal (as of ResourceProperties.reload(ReloadMode) being called
with ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
int aScheduleTimeInMillis) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the given poll loop time and
orphan removal (as of ResourceProperties.reload(ReloadMode) being
called with ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
int aScheduleTimeInMillis,
ReloadMode aReloadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the given poll loop time and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
int aScheduleTimeInMillis,
ReloadMode aReloadMode,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the given poll loop time and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode) being called with your
argument). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
int aScheduleTimeInMillis,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the given poll loop time and
orphan removal (as of ResourceProperties.reload(ReloadMode) being
called with ReloadMode.ORPHAN_REMOVAL ). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
ReloadMode aReloadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the the default poll loop time of
10 seconds (as of PollLoopTime.NORM and the given orphan removal
strategy (as of ResourceProperties.reload(ReloadMode) being
called with your argument). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
ReloadMode aReloadMode,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with setting the the default poll loop time of
10 seconds (as of PollLoopTime.NORM and the given orphan removal
strategy (as of ResourceProperties.reload(ReloadMode) being
called with your argument). |
static ScheduledResourceProperties |
schedule(ResourceProperties aProperties,
org.refcodes.controlflow.ThreadMode aThreadMode) |
Creates a
ScheduledResourcePropertiesDecorator wrapping the given
ResourceProperties with default settings being a poll loop time
of 10 seconds (as of PollLoopTime.NORM and orphan removal (as of
ResourceProperties.reload(ReloadMode) being called with
ReloadMode.ORPHAN_REMOVAL ). |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromJavaProperties(File aFile) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromJavaProperties(String aFilePath) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromJsonProperties(File aFile) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromJsonProperties(String aFilePath) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromTomlProperties(File aFile) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromTomlProperties(String aFilePath) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromXmlProperties(File aFile) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromXmlProperties(String aFilePath) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromYamlProperties(File aFile) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static ResourceProperties.ResourcePropertiesBuilder |
seekFromYamlProperties(String aFilePath) |
Loads a properties file from the file directly or (if not found) from
first folder containing such a file as of the specification for the
method
RuntimeUtility.toConfigDirs() . |
static Properties |
toNormalized(Properties aProperties) |
Decorates the provided
Properties with additional behavior by
normalizing the key representing the path pointing to the according
value. |
static Properties |
toNormalized(Properties aProperties,
char[] aDelimiters) |
Decorates the provided
Properties with additional behavior by
normalizing the key representing the path pointing to the according
value. |
static Properties |
toPrecedence(Properties... aProperties) |
Creates a
Properties composite querying the provided
Properties in the given order. |
static Properties.PropertiesBuilder |
toPropertiesBuilder() |
Creates an empty
Properties.PropertiesBuilder . |
static Properties.PropertiesBuilder |
toPropertiesBuilder(Properties... aProperties) |
Creates a new
Properties.PropertiesBuilder from the Properties . |
static org.refcodes.structure.Property |
toProperty(String aKey,
String aValue) |
Creates a
Property from the provided key and the provided value. |
public static ResourceProperties.ResourcePropertiesBuilder loadFromJavaProperties(File aFile) throws IOException, ParseException
File
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJavaProperties(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJavaProperties(InputStream aInputStream) throws IOException, ParseException
InputStream
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aInputStream
- The InputStream
from which to read the
properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJavaProperties(URL aUrl) throws IOException, ParseException
URL
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aUrl
- The URL
from which to read the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromJavaProperties(File aFile) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromJavaProperties(String aFilePath) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromTomlProperties(File aFile) throws IOException, ParseException
File
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromTomlProperties(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromTomlProperties(InputStream aInputStream) throws IOException, ParseException
InputStream
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aInputStream
- The InputStream
from which to read the
properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromTomlProperties(URL aUrl) throws IOException, ParseException
URL
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aUrl
- The URL
from which to read the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromTomlProperties(File aFile) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromTomlProperties(String aFilePath) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJsonProperties(File aFile) throws IOException, ParseException
File
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJsonProperties(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJsonProperties(InputStream aInputStream) throws IOException, ParseException
InputStream
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aInputStream
- The InputStream
from which to read the
properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromJsonProperties(URL aUrl) throws IOException, ParseException
URL
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aUrl
- The URL
from which to read the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromJsonProperties(File aFile) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromJsonProperties(String aFilePath) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromYamlProperties(File aFile) throws IOException, ParseException
File
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromYamlProperties(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromYamlProperties(InputStream aInputStream) throws IOException, ParseException
InputStream
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aInputStream
- The InputStream
from which to read the
properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromYamlProperties(URL aUrl) throws IOException, ParseException
URL
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aUrl
- The URL
from which to read the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromYamlProperties(File aFile) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromYamlProperties(String aFilePath) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromXmlProperties(File aFile) throws IOException, ParseException
File
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromXmlProperties(String aFilePath) throws IOException, ParseException
aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromXmlProperties(InputStream aInputStream) throws IOException, ParseException
InputStream
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aInputStream
- The InputStream
from which to read the
properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder loadFromXmlProperties(URL aUrl) throws IOException, ParseException
URL
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aUrl
- The URL
from which to read the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromXmlProperties(File aFile) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aFile
- The File
from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder seekFromXmlProperties(String aFilePath) throws IOException, ParseException
RuntimeUtility.toConfigDirs()
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aFilePath
- The path to the file from which to load the properties.Properties
instance.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.public static ResourceProperties.ResourcePropertiesBuilder saveToJavaProperties(Properties aProperties, File aFile) throws IOException
File
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToJavaProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToJavaProperties(Properties aProperties, OutputStream aOutputStream) throws IOException
OutputStream
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aProperties
- The Properties
to save.aOutputStream
- The OutputStream
to which to write the
properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToTomlProperties(Properties aProperties, File aFile) throws IOException
File
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToTomlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToTomlProperties(Properties aProperties, OutputStream aOutputStream) throws IOException
OutputStream
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aProperties
- The Properties
to save.aOutputStream
- The OutputStream
to which to write the
properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToJsonProperties(Properties aProperties, File aFile) throws IOException
File
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToJsonProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToJsonProperties(Properties aProperties, OutputStream aOutputStream) throws IOException
OutputStream
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aProperties
- The Properties
to save.aOutputStream
- The OutputStream
to which to write the
properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToYamlProperties(Properties aProperties, File aFile) throws IOException
File
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToYamlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToYamlProperties(Properties aProperties, OutputStream aOutputStream) throws IOException
OutputStream
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aProperties
- The Properties
to save.aOutputStream
- The OutputStream
to which to write the
properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToXmlProperties(Properties aProperties, File aFile) throws IOException
File
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToXmlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder saveToXmlProperties(Properties aProperties, OutputStream aOutputStream) throws IOException
OutputStream
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aProperties
- The Properties
to save.aOutputStream
- The OutputStream
to which to write the
properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToJavaProperties(Properties aProperties, File aFile) throws IOException
File
.
For Java properties, see "https://en.wikipedia.org/wiki/.properties".aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToJavaProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToTomlProperties(Properties aProperties, File aFile) throws IOException
File
.
For TOML properties, see "https://en.wikipedia.org/wiki/TOML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToTomlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToJsonProperties(Properties aProperties, File aFile) throws IOException
File
.
For JSON properties, see "https://en.wikipedia.org/wiki/JSON"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToJsonProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToYamlProperties(Properties aProperties, File aFile) throws IOException
File
.
For YAML properties, see "https://en.wikipedia.org/wiki/YAML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToYamlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToXmlProperties(Properties aProperties, File aFile) throws IOException
File
.
For XML properties, see "https://en.wikipedia.org/wiki/XML"aProperties
- The Properties
to save.aFile
- The File
to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static ResourceProperties.ResourcePropertiesBuilder fileToXmlProperties(Properties aProperties, String aFilePath) throws IOException
aProperties
- The Properties
to save.aFilePath
- The path to the file to which to save the properties.ResourceProperties
instance.IOException
- thrown in case writing or processing the properties
file failed.public static Properties toPrecedence(Properties... aProperties)
Properties
composite querying the provided
Properties
in the given order. Queried properties of the first
Properties
instance containing them are returned.
Properties
before have a higher precedence over
Properties
provided next.aProperties
- The Properties
to be queried in the provided
order.Properties
composite querying the provided properties
in the given order.public static Properties toNormalized(Properties aProperties)
Properties
with additional behavior by
normalizing the key representing the path pointing to the according
value.
You provide Properties
with a path delimiter different from the
default delimiter and you get Properties
which act as if the
delimiter was the default delimiter:
Paths containing the namespace delimiter "." (as of
Delimiter.NAMESPACE
are converted to paths' with delimiter "/"
(as of Delimiter.PATH
.
Changes applied to the provided Properties
affect the decorator.aProperties
- The Properties
to be decorated.Properties
decorator normalizing the the provided
Properties
' paths.public static Properties toNormalized(Properties aProperties, char[] aDelimiters)
Properties
with additional behavior by
normalizing the key representing the path pointing to the according
value.
You provide Properties
with a path delimiter different from the
default delimiter and you get Properties
which act as if the
delimiter was the default delimiter:
Paths containing the provided delimiters are converted to the paths' with
delimiter "/" (as of Delimiter.PATH
.
Changes applied to the provided Properties
affect the decorator.aProperties
- The Properties
to be decorated.aDelimiters
- The delimiters to be converted forth and backProperties
decorator normalizing the the provided
Properties
' paths.public static Properties.PropertiesBuilder toPropertiesBuilder()
Properties.PropertiesBuilder
.Properties.PropertiesBuilder
.public static Properties.PropertiesBuilder toPropertiesBuilder(Properties... aProperties)
Properties.PropertiesBuilder
from the Properties
.
Succeeding provided Properties
overrule provided preceding
Properties
.aProperties
- The Properties
to be added to the resulting
Properties.PropertiesBuilder
. The later the Properties
in the
varargs chain, the more do they overrule the earlier
Properties
from the varargs chain.Properties.PropertiesBuilder
containing the provided properties.public static org.refcodes.structure.Property toProperty(String aKey, String aValue)
Property
from the provided key and the provided value.aKey
- The name of the property.aValue
- The value of the property.Property
representing the key/value-pair.@Deprecated public static org.refcodes.structure.Property from(String aKey, String aValue)
Property
from the provided key and the provided value.aKey
- The name of the property.aValue
- The value of the property.Property
representing the key/value-pair.public static Properties.PropertiesBuilder fromProperties(org.refcodes.structure.Property... aProperties)
Properties
instance from the provided Property
instances. Use toProperty(String, String)
to compose your
properties to be added.aProperties
- The Property
instances' key/value-pairs to be
added.Properties.PropertiesBuilder
containing the provided
Property
instances.@Deprecated public static Properties.PropertiesBuilder from(org.refcodes.structure.Property... aProperties)
Properties
instance from the provided Property
instances. Use toProperty(String, String)
to compose your
properties to be added.aProperties
- The Property
instances' key/value-pairs to be
added.Properties.PropertiesBuilder
containing the provided
Property
instances.public static Properties fromSystemProperties()
Properties
representing the system properties as passed
via the "-Dkey=value" when launching the JVM (e.g.java
-Dconsole.width=220).public static Properties fromEnvironmentVariables()
Properties
representing the operating system's
environment variables as of env
on Linux or Unix shells or
set
on Windows machines.public static Properties fromProfile(Properties aProperties, String... aProfiles)
Properties
with a profile projection. The
Properties
are decorated with a
ProfilePropertiesProjection
which represents the wrapped
Properties
with the given profiles applied. See also
ProfileProperties.toRuntimeProfile(String...)
.aProperties
- The properties which are to be projected according to
the provided profiles. The evaluation is done as of
ProfileProperties.toRuntimeProfile(String...)
.aProfiles
- The profiles to be used when constructing the
projection.Properties
projection as of the provided profiles.public static Properties fromProfile(Properties aProperties)
Properties
with a profile projection. The
Properties
are decorated with a
ProfilePropertiesProjection
which represents the wrapped
Properties
with the given profiles applied. See also
ProfileProperties.toRuntimeProfile(String...)
.
The profiles being used are found at the given Properties
"runtime/profiles" path as defined by
PropertiesPath.RUNTIME_PROFILES_PATH
. This path points to an
array with the Runtime-Profiles denoted as follows, pointing to your
active Runtime-Profiles:
runtime/profiles=local,oauth,development
This array beats the above kind of declaration so that the active
Runtime-Profiles can easily be overwritten by ProfileProperties
supporting Java System-Properties (passed to the JVM via "-Dx=y") e.g.
the RuntimePropertiesComposite
found in the
refcodes-runtime
artifact.aProperties
- The properties which are to be projected according to
the profiles provided by the given Properties
. The
evaluation is done as of
ProfileProperties.toRuntimeProfile()
.Properties
projection as of the profiles provided by
the given Properties
.public static ScheduledResourceProperties schedule(ResourceProperties aProperties) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with default settings being a poll loop time
of 10 seconds (as of PollLoopTime.NORM
and orphan removal (as of
ResourceProperties.reload(ReloadMode)
being called with
ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, int aScheduleTimeInMillis) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the given poll loop time and
orphan removal (as of ResourceProperties.reload(ReloadMode)
being
called with ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, ReloadMode aReloadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the the default poll loop time of
10 seconds (as of PollLoopTime.NORM
and the given orphan removal
strategy (as of ResourceProperties.reload(ReloadMode)
being
called with your argument).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.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.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the given poll loop time and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.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.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with default settings being a
poll loop time of 10 seconds (as of PollLoopTime.NORM
) and orphan
removal (as of ResourceProperties.reload(ReloadMode)
being called
with ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, int aScheduleTimeInMillis) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the given poll
loop time and orphan removal (as of
ResourceProperties.reload(ReloadMode)
being called with
ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, ReloadMode aReloadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the the default
poll loop time of 10 seconds (as of PollLoopTime.NORM
) and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.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.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the given poll
loop time and the given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.
The scheduling Thread
is started as daemon thread (see
ThreadMode.DAEMON
).aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.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.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with default settings being a poll loop time
of 10 seconds (as of PollLoopTime.NORM
and orphan removal (as of
ResourceProperties.reload(ReloadMode)
being called with
ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, int aScheduleTimeInMillis, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the given poll loop time and
orphan removal (as of ResourceProperties.reload(ReloadMode)
being
called with ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, ReloadMode aReloadMode, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the the default poll loop time of
10 seconds (as of PollLoopTime.NORM
and the given orphan removal
strategy (as of ResourceProperties.reload(ReloadMode)
being
called with your argument).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.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.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties schedule(ResourceProperties aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesDecorator
wrapping the given
ResourceProperties
with setting the given poll loop time and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.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.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties
encapsulating the
provided ResourceProperties
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with default settings being a
poll loop time of 10 seconds (as of PollLoopTime.NORM
) and orphan
removal (as of ResourceProperties.reload(ReloadMode)
being called
with ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, int aScheduleTimeInMillis, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the given poll
loop time and orphan removal (as of
ResourceProperties.reload(ReloadMode)
being called with
ReloadMode.ORPHAN_REMOVAL
).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, ReloadMode aReloadMode, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the the default
poll loop time of 10 seconds (as of PollLoopTime.NORM
) and the
given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.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.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.public static ScheduledResourceProperties.ScheduledResourcePropertiesBuilder schedule(ResourceProperties.ResourcePropertiesBuilder aProperties, int aScheduleTimeInMillis, ReloadMode aReloadMode, org.refcodes.controlflow.ThreadMode aThreadMode) throws IllegalStateException, IOException, ParseException
ScheduledResourcePropertiesBuilderDecorator
wrapping
the given ResourceProperties.ResourcePropertiesBuilder
with setting the given poll
loop time and the given orphan removal strategy (as of
ResourceProperties.reload(ReloadMode)
being called with your
argument).
Immediately starts polling after construction of this instance for new
properties.aProperties
- The properties from which the properties are to be
reloaded periodically.aScheduleTimeInMillis
- The time in milliseconds between polling for
new properties.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.aThreadMode
- The ThreadMode
mode of operation regarding the
Thread
doing the scheduling job.ScheduledResourceProperties.ScheduledResourcePropertiesBuilder
encapsulating the
provided ResourceProperties.ResourcePropertiesBuilder
.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.