Interface Properties

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Properties.MutableProperties
      The interface Properties.MutableProperties defines "dirty" methods allowing to modify ("mutate") the properties.
      static interface  Properties.PropertiesBuilder
      The interface Properties.PropertiesBuilder defines builder functionality on top of the properties .
      • Nested classes/interfaces inherited from interface org.refcodes.structure.CanonicalMap

        org.refcodes.structure.CanonicalMap.CanonicalMapBuilder, org.refcodes.structure.CanonicalMap.MutableCanonicalMap
      • Nested classes/interfaces inherited from interface org.refcodes.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.structure.Dictionary

        org.refcodes.structure.Dictionary.MutableDictionary<K extends java.lang.Object,V extends java.lang.Object>
      • Nested classes/interfaces inherited from interface org.refcodes.structure.Keys

        org.refcodes.structure.Keys.MutableKeys<K extends java.lang.Object,V extends java.lang.Object>, org.refcodes.structure.Keys.MutableValues<K extends java.lang.Object,V extends java.lang.Object>
      • Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

        org.refcodes.structure.PathMap.MutablePathMap<T extends java.lang.Object>, org.refcodes.structure.PathMap.PathMapBuilder<T extends java.lang.Object>
      • Nested classes/interfaces inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin<T extends java.lang.Object>, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMixin, org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin
      • Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

        org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_COMMENT  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      Properties childrenOf​(java.lang.String aParentPath)
      default boolean containsValue​(java.lang.Object value)
      default char getDelimiter()
      Returns the default path delimiter as of Delimiter.PATH.
      default Properties getIndexed​(int aIndex)
      default Properties getIndexed​(java.lang.String aPath, int aIndex)
      default java.lang.Class<java.lang.String> getType()
      default Properties query​(java.lang.String aPathQuery)
      default Properties query​(java.lang.String aPathQuery, java.lang.String aFromPath, java.lang.String aToPath)
      default Properties queryFrom​(java.lang.String aPathQuery, java.lang.String aFromPath)
      default Properties queryTo​(java.lang.String aPathQuery, java.lang.String aToPath)
      default Properties retrieve​(java.lang.String aFromPath, java.lang.String aToPath)
      Properties retrieveFrom​(java.lang.String aFromPath)
      Properties retrieveTo​(java.lang.String aToPath)
      default java.util.Map<java.lang.String,java.lang.String> toMap()
      This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
      default java.util.Properties toProperties()
      This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
      default java.lang.String toPropertyPath​(java.lang.String aPath)
      Converts the properties for saving; that when saved, them properties will not start with a delimiter, making them (when there are no sub-paths for the properties) look just like normal well known properties, enabling interchangeability with other systems reading the properties.
      • Methods inherited from interface org.refcodes.structure.CanonicalMap

        toInstance, toInstance, toType, toType
      • Methods inherited from interface org.refcodes.structure.Containable

        isEmpty, size
      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump, toDump
      • Methods inherited from interface org.refcodes.structure.Keys

        containsKey, get, keySet, use, values
      • Methods inherited from interface org.refcodes.structure.PathMap

        directories, directories, entries, entries, fromExternalKey, get, get, getArray, getArray, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getIndexes, getIndexes, getInteger, getInteger, getLong, getLong, getRootPath, getShort, getShort, hasIndexed, hasIndexed, hasParentPath, isArray, isArray, isDirectory, isEntry, isIndexed, isIndexed, isPath, isRecord, isRootPath, keySet, paths, paths, queryPaths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toPath
      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort
    • Field Detail

      • DEFAULT_COMMENT

        static final java.lang.String DEFAULT_COMMENT
    • Method Detail

      • getDelimiter

        default char getDelimiter()
        Returns the default path delimiter as of Delimiter.PATH.
        Specified by:
        getDelimiter in interface org.refcodes.mixin.DelimiterAccessor
      • getType

        default java.lang.Class<java.lang.String> getType()
        Specified by:
        getType in interface org.refcodes.mixin.TypeAccessor<java.lang.String>
      • toProperties

        default java.util.Properties toProperties()
        This method creates a Properties instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
        Returns:
        A Properties object from the herein contained key/value-pairs .
      • containsValue

        default boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface org.refcodes.structure.CanonicalMap
        Specified by:
        containsValue in interface org.refcodes.structure.Keys<java.lang.String,java.lang.String>
      • toMap

        default java.util.Map<java.lang.String,java.lang.String> toMap()
        This method creates a Map instance from this Properties instance's elements (key/value-pairs) as of interoperability reasons.
        Specified by:
        toMap in interface org.refcodes.structure.PathMap<java.lang.String>
        Returns:
        A Map object from the herein contained key/value-pairs .
      • toPropertyPath

        default java.lang.String toPropertyPath​(java.lang.String aPath)
        Converts the properties for saving; that when saved, them properties will not start with a delimiter, making them (when there are no sub-paths for the properties) look just like normal well known properties, enabling interchangeability with other systems reading the properties.
        Parameters:
        aPath - The path to be normalized.
        Returns:
        The normalized path; afterwards it does not start with a delimiter any more.
      • retrieveFrom

        Properties retrieveFrom​(java.lang.String aFromPath)
        Specified by:
        retrieveFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveFrom in interface org.refcodes.structure.PathMap<java.lang.String>
      • retrieveTo

        Properties retrieveTo​(java.lang.String aToPath)
        Specified by:
        retrieveTo in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveTo in interface org.refcodes.structure.PathMap<java.lang.String>
      • childrenOf

        Properties childrenOf​(java.lang.String aParentPath)
        Specified by:
        childrenOf in interface org.refcodes.structure.CanonicalMap
        Specified by:
        childrenOf in interface org.refcodes.structure.PathMap<java.lang.String>
      • retrieve

        default Properties retrieve​(java.lang.String aFromPath,
                                    java.lang.String aToPath)
        Specified by:
        retrieve in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieve in interface org.refcodes.structure.PathMap<java.lang.String>
      • getIndexed

        default Properties getIndexed​(int aIndex)
        Specified by:
        getIndexed in interface org.refcodes.structure.CanonicalMap
        Specified by:
        getIndexed in interface org.refcodes.structure.PathMap<java.lang.String>
      • getIndexed

        default Properties getIndexed​(java.lang.String aPath,
                                      int aIndex)
        Specified by:
        getIndexed in interface org.refcodes.structure.CanonicalMap
        Specified by:
        getIndexed in interface org.refcodes.structure.PathMap<java.lang.String>
      • query

        default Properties query​(java.lang.String aPathQuery)
        Specified by:
        query in interface org.refcodes.structure.CanonicalMap
        Specified by:
        query in interface org.refcodes.structure.PathMap<java.lang.String>
      • queryTo

        default Properties queryTo​(java.lang.String aPathQuery,
                                   java.lang.String aToPath)
        Specified by:
        queryTo in interface org.refcodes.structure.CanonicalMap
        Specified by:
        queryTo in interface org.refcodes.structure.PathMap<java.lang.String>
      • queryFrom

        default Properties queryFrom​(java.lang.String aPathQuery,
                                     java.lang.String aFromPath)
        Specified by:
        queryFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        queryFrom in interface org.refcodes.structure.PathMap<java.lang.String>
      • query

        default Properties query​(java.lang.String aPathQuery,
                                 java.lang.String aFromPath,
                                 java.lang.String aToPath)
        Specified by:
        query in interface org.refcodes.structure.CanonicalMap
        Specified by:
        query in interface org.refcodes.structure.PathMap<java.lang.String>