Class RuntimePropertiesSugar
java.lang.Object
org.refcodes.properties.PropertiesSugar
org.refcodes.properties.ext.runtime.RuntimePropertiesSugar
public class RuntimePropertiesSugar
extends org.refcodes.properties.PropertiesSugar
Declarative syntactic sugar which may be statically imported in order to
allow declarative definitions for the construction of
RuntimeProperties
(and the like).-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RuntimeProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withFilePath
(String aFilePath) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withInputStream
(InputStream aInputStream) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withObfuscationMode
(org.refcodes.runtime.SystemContext aMode) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withParseArgs
(String[] aArgs) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withProperties
(org.refcodes.properties.Properties aProperties) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withRootArgsSyntax
(org.refcodes.cli.ArgsSyntax aRootArgsSyntax) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withRootOption
(org.refcodes.cli.Option<?> aRootOption) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
withSecret
(String aSecret) Factory method to conveniently create a pre-configuredRuntimeProperties
instance.static RuntimeProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance.Methods inherited from class org.refcodes.properties.PropertiesSugar
fileToJavaProperties, fileToJavaProperties, fileToJsonProperties, fileToJsonProperties, fileToTomlProperties, fileToTomlProperties, fileToXmlProperties, fileToXmlProperties, fileToYamlProperties, fileToYamlProperties, from, from, fromEnvironmentVariables, fromProfile, fromProfile, fromProperties, fromSystemProperties, loadFromJavaProperties, loadFromJavaProperties, loadFromJavaProperties, loadFromJavaProperties, loadFromJsonProperties, loadFromJsonProperties, loadFromJsonProperties, loadFromJsonProperties, loadFromTomlProperties, loadFromTomlProperties, loadFromTomlProperties, loadFromTomlProperties, loadFromXmlProperties, loadFromXmlProperties, loadFromXmlProperties, loadFromXmlProperties, loadFromYamlProperties, loadFromYamlProperties, loadFromYamlProperties, loadFromYamlProperties, saveToJavaProperties, saveToJavaProperties, saveToJavaProperties, saveToJsonProperties, saveToJsonProperties, saveToJsonProperties, saveToTomlProperties, saveToTomlProperties, saveToTomlProperties, saveToXmlProperties, saveToXmlProperties, saveToXmlProperties, saveToYamlProperties, saveToYamlProperties, saveToYamlProperties, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, seekFromJavaProperties, seekFromJavaProperties, seekFromJsonProperties, seekFromJsonProperties, seekFromTomlProperties, seekFromTomlProperties, seekFromXmlProperties, seekFromXmlProperties, seekFromYamlProperties, seekFromYamlProperties, toNormalized, toNormalized, toPrecedence, toPropertiesBuilder, toPropertiesBuilder, toProperty
-
Constructor Details
-
RuntimePropertiesSugar
public RuntimePropertiesSugar()
-
-
Method Details
-
fromRuntimeProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs aRuntimeProperties
instance with noArgsSyntax
for parsing command line arguments. As no syntax notation is required by the constructor (no rootArgsSyntax
), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments when invokingwithArgs(String[])
.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withArgs
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs aRuntimeProperties
instance with noArgsSyntax
for parsing command line arguments: As no syntax notation is required by the constructor (no rootArgsSyntax
), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.- Parameters:
aArgs
- The command line arguments to be evaluated.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withRootArgsSyntax
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs aRuntimeProperties
instance with the givenArgsSyntax
representing the syntax to be used to parse command line arguments. Provide command line arguments viaArgsParserProperties.evalArgs(String[])
(and the like methods).- Parameters:
aRootArgsSyntax
- The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments viaArgsParserProperties.evalArgs(String[])
.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withRootOption
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs aRuntimeProperties
instance with the givenOption
representing the syntax to be used to parse command line arguments. Provide command line arguments viaArgsParserProperties.evalArgs(String[])
(and the like methods).- Parameters:
aRootOption
- The root option being the node from which parsing the command line arguments starts. Parse the command line arguments viaArgsParserProperties.evalArgs(String[])
.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withObfuscationMode
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs theRuntimeProperties
with the given obfuscation mode- Parameters:
aMode
- TheSystemContext
specifies which level of obfuscation is to be used when encountering upon obfuscated properties: E.g. obfuscation may be bound to the host, the "secret" used for obfuscation being the same for all applications on the same host or obfuscation may be bound to the application, being different for different applications on the same host.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withSecret
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Constructs aRuntimeProperties
instance with a custom secret for obfuscation.- Parameters:
aSecret
- The secret to be used when encountering upon obfuscated properties.- Returns:
- The accordingly constructed
RuntimeProperties
instance.
-
withFile
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. 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 methodConfigLocator.getFolders()
.- Parameters:
aFile
- The file of the properties to load.- Returns:
- The
RuntimeProperties
instance as of the builder pattern for chained method calls. - 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.
-
withInputStream
public static RuntimeProperties withInputStream(InputStream aInputStream) throws IOException, ParseException Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Reads the properties from the givenInputStream
.- Parameters:
aInputStream
- TheInputStream
from which to read the properties.- Returns:
- The
RuntimeProperties
instance as of the builder pattern for chained method calls. - 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.
-
withFilePath
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. 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 methodConfigLocator.getFolders()
.- Parameters:
aFilePath
- The file of the properties file to load.- Returns:
- The
RuntimeProperties
instance as of the builder pattern for chained method calls. - 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.
-
withUrl
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Loads the properties from the givenURL
.- Parameters:
aUrl
- TheURL
from which to read the properties.- Returns:
- The
RuntimeProperties
instance as of the builder pattern for chained method calls. - 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.
-
withParseArgs
public static RuntimeProperties withParseArgs(String[] aArgs) throws org.refcodes.cli.ArgsSyntaxException Factory method to conveniently create a pre-configuredRuntimeProperties
instance. Evaluates the provided command line arguments and adds them with their according properties representation- Parameters:
aArgs
- The command line arguments to be evaluated.- Returns:
- The
RuntimeProperties
instance of the builder pattern to chain further method calls. - Throws:
org.refcodes.cli.ArgsSyntaxException
- thrown in case of a command line arguments mismatch regarding provided and expected args.
-
withProperties
Factory method to conveniently create a pre-configuredRuntimeProperties
instance. A hook for you to provideProperties
programmatically. The later you addProperties
, the lower their precedence.- Parameters:
aProperties
- TheProperties
to be added.- Returns:
- The
RuntimeProperties
instance of the builder pattern to chain further method calls.
-