Module org.refcodes.runtime
Package org.refcodes.runtime

Class PropertyBuilder

  • All Implemented Interfaces:
    org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,​PropertyBuilder>, org.refcodes.mixin.KeyAccessor.KeyMutator<String>, org.refcodes.mixin.KeyAccessor.KeyProperty<String>
    public class PropertyBuilder
extends Object
implements org.refcodes.mixin.KeyAccessor.KeyProperty<String>, org.refcodes.mixin.KeyAccessor.KeyBuilder<String,​PropertyBuilder>
    Converts a key to the format of a system property (camel-case) or an environment variable (snake-case in upper-case).

    • Constructor Detail

      • PropertyBuilder

        public PropertyBuilder()

    • Method Detail

      • getKey

        public String getKey()
        Specified by:
        getKey in interface org.refcodes.mixin.KeyAccessor<String>

      • setKey

        public void setKey​(String aKey)
        Specified by:
        setKey in interface org.refcodes.mixin.KeyAccessor.KeyMutator<String>

      • toPath

        public String toPath()
        Converts the key as of getKey() to a path (as of PathMap). A path begins with a path delimiter "/" (as of Delimiter.PATH and with all non alphanumeric digits being replaced by the path delimiter. Any non alphanumeric sequence is truncated to a single path delimiter.
        Returns:
        The path representation of the according key.

      • toPath

        public String toPath​(String aKey)
        Converts the provided key as of getKey() to a path (as of PathMap). A path begins with a path delimiter "/" (as of Delimiter.PATH and with all non alphanumeric digits being replaced by the path delimiter. Any non alphanumeric sequence is truncated to a single path delimiter.
        Parameters:
        aKey - The key to be converted.
        Returns:
        The path representation of the according key.

      • toSystemProperty

        public String toSystemProperty()
        Converts the key as of getKey() to a system property. A system property is the camel-case version of the according key.
        Returns:
        The camel-case representation of the according key.

      • toEnvironmentVariable

        public String toEnvironmentVariable()
        Converts the key as of getKey() to an environment variable. An environment variable is the upper-case snake-case version of the according key.
        Returns:
        The upper-case snake-case representation of the according key.

      • toSystemProperty

        public String toSystemProperty​(String aKey)
        Converts the provided key to a system property. A system property is the camel-case version of the according key.
        Parameters:
        aKey - The key to be converted.
        Returns:
        The camel-case representation of the according key.

      • toEnvironmentVariable

        public String toEnvironmentVariable​(String aKey)
        Converts the provided key to an environment variable. An environment variable is the upper-case snake-case version of the according key.
        Parameters:
        aKey - The key to be converted.
        Returns:
        The upper-case snake-case representation of the according key.

      • getSystemProperty

        public String getSystemProperty​(String aKey)
        Returns the according system's property after having converted the provided key to a system property. A system property is the camel-case version of the according key.
        Parameters:
        aKey - The value of the key to be converted.
        Returns:
        The system's property of the camel-case representation of the according key.

      • getEnvironmentVariable

        public String getEnvironmentVariable​(String aKey)
        Returns the according environment variable after having converted the provided key to an environment variable. An environment variable is the upper-case snake-case version of the according key.
        Parameters:
        aKey - The value of the key to be converted.
        Returns:
        The environment variable of the upper-case snake-case representation of the according key.

      • asNormalized

        protected static String asNormalized​(String aText,
                                     char aSeparator)
        Normalizes the provided text.
        Parameters:
        aText - The text to be normalized.
        aSeparator - The character to be used for normalization.
        Returns:
        The normalized String (can be null).