Module org.refcodes.properties.ext.runtime
Package org.refcodes.properties.ext.runtime

Class RuntimePropertiesImpl

  • All Implemented Interfaces:
    org.refcodes.cli.ArgsParser, org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>, org.refcodes.cli.RootConditionAccessor, org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<RuntimeProperties>, org.refcodes.cli.RootConditionAccessor.RootConditionMutator, org.refcodes.component.Resetable, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.mixin.ResetEscapeCodeAccessor, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty, org.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.TitleAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty, org.refcodes.mixin.TypeAccessor<String>, ArgsParserProperties, ArgsParserPropertiesAccessor, RuntimeProperties, org.refcodes.properties.ProfileProperties, org.refcodes.properties.Properties, org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>, org.refcodes.properties.ResourceProperties, org.refcodes.struct.CanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.Dictionary<String,​String>, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,​String>, org.refcodes.struct.PathMap<String>, org.refcodes.textual.TextBoxGridAccessor, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty
    public class RuntimePropertiesImpl
extends org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>
implements RuntimeProperties
    The RuntimePropertiesImpl composite represent command line properties, system properties as well as environment variables (in that order) and resource properties. The RuntimePropertiesImpl are actually constructed from ArgsParserProperties, SystemProperties, EnvironmentProperties and ResourceProperties instances (in that precedence). Add the ResourceProperties via the following methods RuntimeProperties.withFile(File), RuntimeProperties.withFilePath(String), RuntimeProperties.withUrl(URL) or RuntimeProperties.withInputStream(InputStream). Obfuscation may be applied to the properties as of the ObfuscationProperties and ObfuscationProperties.ObfuscationPropertiesBuilder types.

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

        org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

      • Nested classes/interfaces inherited from interface org.refcodes.struct.CanonicalMap

        org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap

      • 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.DescriptionAccessor

        org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

      • Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary

        org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,​V extends Object>

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.EmptyAccessor

        org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor

        org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B extends org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty

      • Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

        org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

      • Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

        org.refcodes.struct.Keys.MutableKeys<K extends Object,​V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,​V extends Object>

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

        org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

      • Nested classes/interfaces inherited from interface org.refcodes.struct.PathMap

        org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

      • Nested classes/interfaces inherited from interface org.refcodes.properties.ProfileProperties

        org.refcodes.properties.ProfileProperties.MutableProfileProperties, org.refcodes.properties.ProfileProperties.ProfilePropertiesBuilder

      • Nested classes/interfaces inherited from interface org.refcodes.properties.Properties

        org.refcodes.properties.Properties.MutableProperties, org.refcodes.properties.Properties.PropertiesBuilder

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor

        org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B extends org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty

      • Nested classes/interfaces inherited from interface org.refcodes.properties.ResourceProperties

        org.refcodes.properties.ResourceProperties.MutableResoureProperties, org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder

      • Nested classes/interfaces inherited from interface org.refcodes.cli.RootConditionAccessor

        org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<B extends org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<B>>, org.refcodes.cli.RootConditionAccessor.RootConditionMutator, org.refcodes.cli.RootConditionAccessor.RootConditionProperty

      • Nested classes/interfaces inherited from interface org.refcodes.textual.TextBoxGridAccessor

        org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<B extends org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<?>>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

      • Nested classes/interfaces inherited from interface org.refcodes.mixin.TitleAccessor

        org.refcodes.mixin.TitleAccessor.TitleBuilder<B extends org.refcodes.mixin.TitleAccessor.TitleBuilder<B>>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty

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

        org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,​B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,​B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

    • Field Summary

      • Fields inherited from interface org.refcodes.struct.PathMap

        ANNOTATOR, DELIMITER

      • Fields inherited from interface org.refcodes.properties.Properties

        DEFAULT_COMMENT

    • Constructor Summary

      Constructors 
      Constructor Description
      RuntimePropertiesImpl()
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments.
      RuntimePropertiesImpl​(String aSecret)
      Constructs a RuntimeProperties instance with a custom secret for obfuscation.
      RuntimePropertiesImpl​(String[] aArgs)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(String[] aArgs, String aSecret)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax, String aSecret)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption)
      Constructs a RuntimeProperties instance with the given Option used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption, String aSecret)
      Constructs a RuntimeProperties instance with the given Option used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with the given Option used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aSecret)
      Constructs a RuntimeProperties instance with a custom secret for obfuscation.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, String aSecret)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.ArgsSyntax aRootArgsSyntax, String aSecret)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.ArgsSyntax aRootArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Option<?> aRootOption)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Option<?> aRootOption, String aSecret)
      Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Option<?> aRootOption, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a RuntimeProperties instance with the given Option used to parse command line arguments.
      RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs the RuntimeProperties with the given obfuscation mode
      RuntimePropertiesImpl​(org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs the RuntimeProperties with the given obfuscation mode

    • Constructor Detail

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl()
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments. As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments when invoking withEvalArgs(String[]).

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(String[] aArgs)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
        Parameters:
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption)
        Constructs a RuntimeProperties instance with the given Option used to parse command line arguments.
        Parameters:
        aRootOption - The root option being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs the RuntimeProperties with the given obfuscation mode
        Parameters:
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(String[] aArgs,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode
        Parameters:
        aArgs - The command line arguments to be evaluated.
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode.
        Parameters:
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with the given Option used to parse command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode.
        Parameters:
        aRootOption - The root option being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(String aSecret)
        Constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(String[] aArgs,
                             String aSecret)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aArgs - The command line arguments to be evaluated.
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax,
                             String aSecret)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.cli.Option<?> aRootOption,
                             String aSecret)
        Constructs a RuntimeProperties instance with the given Option used to parse command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aRootOption - The root option being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments. As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments when invoking withEvalArgs(String[]).
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             String[] aArgs)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aArgs - The command line arguments to be evaluated.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.Option<?> aRootOption)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootOption - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs the RuntimeProperties with the given obfuscation mode
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             String[] aArgs,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aArgs - The command line arguments to be evaluated.
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.Option<?> aRootOption,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with the given Option used to parse command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootOption - The root option being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.ArgsSyntax aRootArgsSyntax,
                             org.refcodes.runtime.SystemContext aObfuscationMode)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments. Also constructs the RuntimeProperties with the given obfuscation mode.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aObfuscationMode - The SystemContext 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.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             String aSecret)
        Constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             String[] aArgs,
                             String aSecret)
        Constructs a RuntimeProperties instance with no ArgsSyntax for parsing command line arguments: As no syntax notation is required by the constructor (no root ArgsSyntax), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aArgs - The command line arguments to be evaluated.
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.Option<?> aRootOption,
                             String aSecret)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootOption - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aSecret - The secret to be used when encountering upon obfuscated properties.

      • RuntimePropertiesImpl

        public RuntimePropertiesImpl​(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory,
                             org.refcodes.cli.ArgsSyntax aRootArgsSyntax,
                             String aSecret)
        Constructs a RuntimeProperties instance with the given ArgsSyntax used to parse command line arguments. Also constructs a RuntimeProperties instance with a custom secret for obfuscation.
        Parameters:
        aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
        aRootArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
        aSecret - The secret to be used when encountering upon obfuscated properties.

    • Method Detail

      • getExamples

        public List<org.refcodes.cli.Example> getExamples()
        Specified by:
        getExamples in interface org.refcodes.cli.ArgsParser

      • addExample

        public void addExample​(org.refcodes.cli.Example aExampleUsage)
        Specified by:
        addExample in interface org.refcodes.cli.ArgsParser

      • printExamples

        public void printExamples()
        Specified by:
        printExamples in interface org.refcodes.cli.ArgsParser

      • getLineSeparatorEscapeCode

        public String getLineSeparatorEscapeCode()
        Specified by:
        getLineSeparatorEscapeCode in interface org.refcodes.cli.ArgsParser

      • setLineSeparatorEscapeCode

        public void setLineSeparatorEscapeCode​(String aLineSeparatorEscCode)
        Specified by:
        setLineSeparatorEscapeCode in interface org.refcodes.cli.ArgsParser

      • getBannerEscapeCode

        public String getBannerEscapeCode()
        Specified by:
        getBannerEscapeCode in interface org.refcodes.cli.ArgsParser

      • getBannerBorderEscapeCode

        public String getBannerBorderEscapeCode()
        Specified by:
        getBannerBorderEscapeCode in interface org.refcodes.cli.ArgsParser

      • setBannerEscapeCode

        public void setBannerEscapeCode​(String aBannerEscCode)
        Specified by:
        setBannerEscapeCode in interface org.refcodes.cli.ArgsParser

      • setBannerBorderEscapeCode

        public void setBannerBorderEscapeCode​(String aBannerBorderEscCode)
        Specified by:
        setBannerBorderEscapeCode in interface org.refcodes.cli.ArgsParser

      • getDescriptionEscapeCode

        public String getDescriptionEscapeCode()
        Specified by:
        getDescriptionEscapeCode in interface org.refcodes.cli.ArgsParser

      • setDescriptionEscapeCode

        public void setDescriptionEscapeCode​(String aParamDescriptionEscCode)
        Specified by:
        setDescriptionEscapeCode in interface org.refcodes.cli.ArgsParser

      • getCommandEscapeCode

        public String getCommandEscapeCode()
        Specified by:
        getCommandEscapeCode in interface org.refcodes.cli.ArgsParser

      • setCommandEscapeCode

        public void setCommandEscapeCode​(String aCommandEscCode)
        Specified by:
        setCommandEscapeCode in interface org.refcodes.cli.ArgsParser

      • isEscapeCodesEnabled

        public boolean isEscapeCodesEnabled()
        Specified by:
        isEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor

      • setEscapeCodesEnabled

        public void setEscapeCodesEnabled​(boolean isEscCodeEnabled)
        Specified by:
        setEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator

      • getResetEscapeCode

        public String getResetEscapeCode()
        Specified by:
        getResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor

      • setResetEscapeCode

        public void setResetEscapeCode​(String aResetEscCode)
        Specified by:
        setResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator

      • getParamEscapeCode

        public String getParamEscapeCode()
        Specified by:
        getParamEscapeCode in interface org.refcodes.cli.ArgsParser

      • setParamEscapeCode

        public void setParamEscapeCode​(String aParamEscCode)
        Specified by:
        setParamEscapeCode in interface org.refcodes.cli.ArgsParser

      • getOptionEscapeCode

        public String getOptionEscapeCode()
        Specified by:
        getOptionEscapeCode in interface org.refcodes.cli.ArgsParser

      • setOptionEscapeCode

        public void setOptionEscapeCode​(String aOptEscCode)
        Specified by:
        setOptionEscapeCode in interface org.refcodes.cli.ArgsParser

      • getCopyrightNote

        public String getCopyrightNote()
        Specified by:
        getCopyrightNote in interface org.refcodes.cli.ArgsParser

      • getDescription

        public String getDescription()
        Specified by:
        getDescription in interface org.refcodes.cli.ArgsParser
        Specified by:
        getDescription in interface org.refcodes.mixin.DescriptionAccessor

      • getLicenseNote

        public String getLicenseNote()
        Specified by:
        getLicenseNote in interface org.refcodes.cli.ArgsParser

      • setRootArgsSyntax

        public void setRootArgsSyntax​(org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
        Specified by:
        setRootArgsSyntax in interface org.refcodes.cli.RootConditionAccessor.RootConditionMutator

      • setRootOption

        public void setRootOption​(org.refcodes.cli.Option<?> aRootOption)
        Specified by:
        setRootOption in interface org.refcodes.cli.RootConditionAccessor.RootConditionMutator

      • setSecret

        public void setSecret​(String aSecret)
        Specified by:
        setSecret in interface org.refcodes.mixin.SecretAccessor.SecretMutator

      • setObfuscationMode

        public void setObfuscationMode​(org.refcodes.runtime.SystemContext aObfuscationMode)
        Specifies the obfuscation mode to be used.
        Specified by:
        setObfuscationMode in interface RuntimeProperties
        Parameters:
        aObfuscationMode - The SystemContext 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.

      • getSeparatorLnChar

        public char getSeparatorLnChar()
        Specified by:
        getSeparatorLnChar in interface org.refcodes.cli.ArgsParser

      • getTextBoxGrid

        public org.refcodes.textual.TextBoxGrid getTextBoxGrid()
        Specified by:
        getTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor

      • setTextBoxGrid

        public void setTextBoxGrid​(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
        Specified by:
        setTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator

      • withProperties

        public RuntimeProperties withProperties​(org.refcodes.properties.Properties aProperties)
        A hook for you to provide Properties programmatically. The later you add Properties, the lower their precedence.
        Specified by:
        withProperties in interface RuntimeProperties
        Parameters:
        aProperties - The Properties to be added.
        Returns:
        This instance as of the builder pattern to apply method chaining.

      • addProperties

        protected void addProperties​(org.refcodes.properties.Properties aProperties)

      • withEvalArgs

        public RuntimeProperties withEvalArgs​(String[] aArgs)
                               throws org.refcodes.cli.ArgsSyntaxException
        Specified by:
        withEvalArgs in interface org.refcodes.cli.ArgsParser
        Specified by:
        withEvalArgs in interface org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>
        Specified by:
        withEvalArgs in interface ArgsParserProperties
        Specified by:
        withEvalArgs in interface RuntimeProperties
        Throws:
        org.refcodes.cli.ArgsSyntaxException

      • errorLn

        public void errorLn​(String aLine)
        Specified by:
        errorLn in interface org.refcodes.cli.ArgsParser

      • evalArgs

        public List<? extends org.refcodes.cli.Operand<?>> evalArgs​(List<String> aArgs)
                                                     throws org.refcodes.cli.ArgsSyntaxException
        Specified by:
        evalArgs in interface org.refcodes.cli.ArgsParser
        Specified by:
        evalArgs in interface ArgsParserProperties
        Throws:
        org.refcodes.cli.ArgsSyntaxException

      • evalArgs

        public List<? extends org.refcodes.cli.Operand<?>> evalArgs​(String aToPath,
                                                            List<String> aArgs)
                                                     throws org.refcodes.cli.ArgsSyntaxException
        Specified by:
        evalArgs in interface ArgsParserProperties
        Throws:
        org.refcodes.cli.ArgsSyntaxException

      • evalArgs

        public List<? extends org.refcodes.cli.Operand<?>> evalArgs​(String aToPath,
                                                            String[] aArgs)
                                                     throws org.refcodes.cli.ArgsSyntaxException
        Specified by:
        evalArgs in interface ArgsParserProperties
        Throws:
        org.refcodes.cli.ArgsSyntaxException

      • evalArgs

        public List<? extends org.refcodes.cli.Operand<?>> evalArgs​(String[] aArgs)
                                                     throws org.refcodes.cli.ArgsSyntaxException
        Specified by:
        evalArgs in interface org.refcodes.cli.ArgsParser
        Specified by:
        evalArgs in interface ArgsParserProperties
        Throws:
        org.refcodes.cli.ArgsSyntaxException

      • getArgsSyntax

        public org.refcodes.cli.ArgsSyntax getArgsSyntax()
        Specified by:
        getArgsSyntax in interface org.refcodes.cli.ArgsParser
        Specified by:
        getArgsSyntax in interface org.refcodes.cli.RootConditionAccessor

      • printBanner

        public void printBanner()
        Specified by:
        printBanner in interface org.refcodes.cli.ArgsParser

      • printCopyrightNote

        public void printCopyrightNote()
        Specified by:
        printCopyrightNote in interface org.refcodes.cli.ArgsParser

      • printDescription

        public void printDescription()
        Specified by:
        printDescription in interface org.refcodes.cli.ArgsParser

      • printHelp

        public void printHelp()
        Specified by:
        printHelp in interface org.refcodes.cli.ArgsParser

      • printLicenseNote

        public void printLicenseNote()
        Specified by:
        printLicenseNote in interface org.refcodes.cli.ArgsParser

      • printLn

        public void printLn()
        Specified by:
        printLn in interface org.refcodes.cli.ArgsParser

      • printLn

        public void printLn​(String aLine)
        Specified by:
        printLn in interface org.refcodes.cli.ArgsParser

      • printOptions

        public void printOptions()
        Specified by:
        printOptions in interface org.refcodes.cli.ArgsParser

      • printSeparatorLn

        public void printSeparatorLn()
        Specified by:
        printSeparatorLn in interface org.refcodes.cli.ArgsParser

      • printSynopsis

        public void printSynopsis()
        Specified by:
        printSynopsis in interface org.refcodes.cli.ArgsParser

      • reset

        public void reset()
        Specified by:
        reset in interface org.refcodes.component.Resetable

      • setBannerFont

        public void setBannerFont​(org.refcodes.textual.Font aBannerFont)
        Specified by:
        setBannerFont in interface org.refcodes.cli.ArgsParser

      • setBannerFontPalette

        public void setBannerFontPalette​(char[] aColorPalette)
        Specified by:
        setBannerFontPalette in interface org.refcodes.cli.ArgsParser

      • setConsoleWidth

        public void setConsoleWidth​(int aConsoleWidth)
        Specified by:
        setConsoleWidth in interface org.refcodes.cli.ArgsParser

      • setCopyrightNote

        public void setCopyrightNote​(String aCopyrightNote)
        Specified by:
        setCopyrightNote in interface org.refcodes.cli.ArgsParser

      • setDescription

        public void setDescription​(String aDescription)
        Specified by:
        setDescription in interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

      • setErrorOut

        public void setErrorOut​(PrintStream aErrorOut)
        Specified by:
        setErrorOut in interface org.refcodes.cli.ArgsParser

      • setLicenseNote

        public void setLicenseNote​(String aLicenseNote)
        Specified by:
        setLicenseNote in interface org.refcodes.cli.ArgsParser

      • setLineBreak

        public void setLineBreak​(String aLineBreak)
        Specified by:
        setLineBreak in interface org.refcodes.cli.ArgsParser

      • setMaxConsoleWidth

        public void setMaxConsoleWidth​(int aMaxConsoleWidth)
        Specified by:
        setMaxConsoleWidth in interface org.refcodes.cli.ArgsParser

      • setName

        public void setName​(String aName)
        Specified by:
        setName in interface org.refcodes.mixin.NameAccessor.NameMutator

      • setSeparatorLnChar

        public void setSeparatorLnChar​(char aSeparatorChar)
        Specified by:
        setSeparatorLnChar in interface org.refcodes.cli.ArgsParser

      • setStandardOut

        public void setStandardOut​(PrintStream aStandardOut)
        Specified by:
        setStandardOut in interface org.refcodes.cli.ArgsParser

      • setSyntaxNotation

        public void setSyntaxNotation​(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
        Specified by:
        setSyntaxNotation in interface org.refcodes.cli.ArgsParser

      • setTitle

        public void setTitle​(String aTitle)
        Specified by:
        setTitle in interface org.refcodes.mixin.TitleAccessor.TitleMutator

      • getDelimiter

        public char getDelimiter()
        Specified by:
        getDelimiter in interface org.refcodes.mixin.DelimiterAccessor
        Specified by:
        getDelimiter in interface org.refcodes.properties.Properties
        Overrides:
        getDelimiter in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • size

        public int size()
        Specified by:
        size in interface org.refcodes.struct.Containable
        Overrides:
        size in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • containsKey

        public boolean containsKey​(Object aKey)
        Specified by:
        containsKey in interface org.refcodes.struct.Keys<String,​String>
        Overrides:
        containsKey in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.refcodes.mixin.EmptyAccessor
        Overrides:
        isEmpty in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • get

        public String get​(Object aKey)
        Specified by:
        get in interface org.refcodes.struct.Keys<String,​String>
        Overrides:
        get in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • keySet

        public Set<String> keySet()
        Specified by:
        keySet in interface org.refcodes.struct.Keys<String,​String>
        Overrides:
        keySet in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • values

        public Collection<String> values()
        Specified by:
        values in interface org.refcodes.struct.Keys<String,​String>
        Overrides:
        values in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • retrieveFrom

        public org.refcodes.properties.Properties retrieveFrom​(String aFromPath)
        Specified by:
        retrieveFrom in interface org.refcodes.struct.CanonicalMap
        Specified by:
        retrieveFrom in interface org.refcodes.struct.PathMap<String>
        Specified by:
        retrieveFrom in interface org.refcodes.properties.Properties
        Overrides:
        retrieveFrom in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • retrieveTo

        public org.refcodes.properties.Properties retrieveTo​(String aToPath)
        Specified by:
        retrieveTo in interface org.refcodes.struct.CanonicalMap
        Specified by:
        retrieveTo in interface org.refcodes.struct.PathMap<String>
        Specified by:
        retrieveTo in interface org.refcodes.properties.Properties
        Overrides:
        retrieveTo in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • getTitle

        public String getTitle()
        Specified by:
        getTitle in interface org.refcodes.mixin.TitleAccessor

      • getName

        public String getName()
        Specified by:
        getName in interface org.refcodes.mixin.NameAccessor

      • toDataStructure

        public Object toDataStructure​(String aFromPath)
        Specified by:
        toDataStructure in interface org.refcodes.struct.PathMap<String>
        Overrides:
        toDataStructure in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • toSerialized

        public String toSerialized()
        Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method. The behavior of this method is implementation specific. See the javadoc of the implementation in question (such as toSerialized()) for implementation details.
        Specified by:
        toSerialized in interface org.refcodes.properties.ResourceProperties
        Specified by:
        toSerialized in interface RuntimeProperties

      • toSerialized

        public String toSerialized​(char aDelimiter)
        Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method. The behavior of this method is implementation specific. See the javadoc of the implementation in question (such as toSerialized()) for implementation details.
        Specified by:
        toSerialized in interface org.refcodes.properties.ResourceProperties
        Specified by:
        toSerialized in interface RuntimeProperties

      • toSerialized

        public String toSerialized​(String aComment,
                           char aDelimiter)
        Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
        Specified by:
        toSerialized in interface org.refcodes.properties.ResourceProperties

      • toRuntimeProfile

        public org.refcodes.properties.Properties toRuntimeProfile​(String... aProfiles)
        Specified by:
        toRuntimeProfile in interface org.refcodes.properties.ProfileProperties

      • getProperties

        protected org.refcodes.properties.Properties getProperties()
        Overrides:
        getProperties in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

      • addProperties

        protected void addProperties​(File aFile,
                             org.refcodes.runtime.ConfigLocator aConfigLocator,
                             char... aDelimiters)
                      throws IOException,
                             ParseException
        Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
        Parameters:
        aFile - The data sink from which to read the ResourceProperties.ResourcePropertiesBuilder.
        aConfigLocator - The ConfigLocator specifying where to seek for properties.
        aDelimiters - The delimiters in the properties file to identity a path delimiter.
        Throws:
        IOException - Thrown in case there were problems reading the data sink.
        ParseException - Thrown in case there were problems parsing the data from the data sink.

      • addProperties

        protected void addProperties​(InputStream aInputStream,
                             char[] aDelimiters)
                      throws IOException,
                             ParseException
        Reads the ResourceProperties from the given data sink.
        Parameters:
        aInputStream - The data sink from which to read the ResourceProperties.
        aDelimiters - The delimiters in the properties file to identity a path delimiter.
        Throws:
        IOException - Thrown in case there were problems reading the data sink.
        ParseException - Thrown in case there were problems parsing the data from the data sink.

      • addProperties

        protected void addProperties​(Class<?> aResourceClass,
                             String aFilePath,
                             org.refcodes.runtime.ConfigLocator aConfigLocator,
                             char... aDelimiters)
                      throws IOException,
                             ParseException
        Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
        Parameters:
        aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
        aFilePath - The data sink from which to read the ResourceProperties.ResourcePropertiesBuilder.
        aConfigLocator - The ConfigLocator specifying where to seek for properties.
        aDelimiters - The delimiters in the properties file to identity a path delimiter.
        Throws:
        IOException - Thrown in case there were problems reading the data sink.
        ParseException - Thrown in case there were problems parsing the data from the data sink.

      • addProperties

        protected void addProperties​(URL aUrl,
                             char... aDelimiters)
                      throws IOException,
                             ParseException
        Reads the ResourceProperties from the given data sink.
        Parameters:
        aUrl - The data sink from which to read the ResourceProperties.
        aDelimiters - The delimiters in the properties file to identity a path delimiter.
        Throws:
        IOException - Thrown in case there were problems reading the data sink.
        ParseException - Thrown in case there were problems parsing the data from the data sink.