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.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.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  
      • Fields inherited from interface org.refcodes.structure.PathMap

        ANNOTATOR, DELIMITER
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default boolean containsValue​(java.lang.Object value)
      default char getAnnotator​()
      Returns the default path annotator as of Annotator.JAVA.
      default char getDelimiter​()
      Returns the default path delimiter as of Delimiter.PATH.
      default Properties getDirAt​(int aIndex)
      default Properties getDirAt​(java.lang.String aPath, int aIndex)
      default java.lang.Class<java.lang.String> getType​()
      default Properties query​(java.lang.Object... aQueryElements)
      default Properties query​(java.lang.String aPathQuery)
      default Properties query​(java.lang.String... aQueryElements)
      default Properties query​(java.util.Collection<?> aQueryElements)
      default Properties query​(java.util.regex.Pattern aRegExp)
      default Properties queryBetween​(java.lang.Object[] aFromPath, java.lang.Object[] aPathQuery, java.lang.Object[] aToPath)
      default Properties queryBetween​(java.lang.Object aFromPath, java.lang.Object aPathQuery, java.lang.Object aToPath)
      default Properties queryBetween​(java.lang.String[] aFromPath, java.lang.String[] aPathQuery, java.lang.String[] aToPath)
      default Properties queryBetween​(java.lang.String aPathQuery, java.lang.String aFromPath, java.lang.String aToPath)
      default Properties queryBetween​(java.util.Collection<?> aFromPath, java.util.Collection<?> aPathQuery, java.util.Collection<?> aToPath)
      default Properties queryFrom​(java.lang.Object[] aPathQuery, java.lang.Object[] aFromPath)
      default Properties queryFrom​(java.lang.Object aPathQuery, java.lang.Object aFromPath)
      default Properties queryFrom​(java.lang.String[] aPathQuery, java.lang.String[] aFromPath)
      default Properties queryFrom​(java.lang.String aPathQuery, java.lang.String aFromPath)
      default Properties queryFrom​(java.util.Collection<?> aPathQuery, java.util.Collection<?> aFromPath)
      default Properties queryFrom​(java.util.regex.Pattern aRegExp, java.lang.String aFromPath)
      default Properties queryTo​(java.lang.Object[] aPathQuery, java.lang.String aToPath)
      default Properties queryTo​(java.lang.Object aPathQuery, java.lang.String aToPath)
      default Properties queryTo​(java.lang.String[] aPathQuery, java.lang.String aToPath)
      default Properties queryTo​(java.lang.String aPathQuery, java.lang.String aToPath)
      default Properties queryTo​(java.util.Collection<?> aPathQuery, java.lang.String aToPath)
      default Properties queryTo​(java.util.regex.Pattern aRegExp, java.lang.String aToPath)
      default Properties retrieveBetween​(java.lang.Object[] aFromPath, java.lang.Object[] aToPath)
      default Properties retrieveBetween​(java.lang.Object aFromPath, java.lang.Object aToPath)
      default Properties retrieveBetween​(java.lang.String[] aFromPath, java.lang.String[] aToPath)
      default Properties retrieveBetween​(java.lang.String aFromPath, java.lang.String aToPath)
      default Properties retrieveBetween​(java.util.Collection<?> aFromPath, java.util.Collection<?> aToPath)
      default Properties retrieveFrom​(java.lang.Object aParentPath)
      default Properties retrieveFrom​(java.lang.Object... aPathElements)
      Properties retrieveFrom​(java.lang.String aFromPath)
      default Properties retrieveFrom​(java.lang.String... aPathElements)
      default Properties retrieveFrom​(java.util.Collection<?> aPathElements)
      default Properties retrieveTo​(java.lang.Object aToPath)
      default Properties retrieveTo​(java.lang.Object... aToPathElements)
      Properties retrieveTo​(java.lang.String aToPath)
      default Properties retrieveTo​(java.lang.String... aToPathElements)
      default Properties retrieveTo​(java.util.Collection<?> aToPathElements)
      • Methods inherited from interface org.refcodes.structure.CanonicalMap

        getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr, queryBetween, toInstance, toInstance, toMap, toProperties, toType, toType
      • Methods inherited from interface org.refcodes.structure.Containable

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

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

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

        children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getDirAt, getDirAt, getDirAt, getDirAt, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isArrayIndex, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isDirIndex, isEqualTo, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath
      • Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

        asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharacterArray, asCharacterArray, asCharacterArray, asCharacterArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntegerArray, asIntegerArray, asIntegerArray, asIntegerArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getByte, getByte, getByteOr, getByteOr, getCharacter, getCharacter, getCharacterOr, getCharacterOr, getDouble, getDouble, getDoubleOr, getDoubleOr, getFloat, getFloat, getFloatOr, getFloatOr, getInteger, getInteger, getIntegerOr, getIntegerOr, getLong, getLong, getLongOr, getLongOr, getShort, getShort, getShortOr, getShortOr
    • Field Detail

      • DEFAULT_COMMENT

        static final java.lang.String DEFAULT_COMMENT
    • Method Detail

      • 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,T extends java.lang.Object>
      • getDelimiter

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

        default char getAnnotator​()
        Returns the default path annotator as of Annotator.JAVA.
        Specified by:
        getAnnotator in interface org.refcodes.mixin.AnnotatorAccessor
      • getDirAt

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

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

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

        default Properties query​(java.util.Collection<?> aQueryElements)
        Specified by:
        query in interface org.refcodes.structure.CanonicalMap
        Specified by:
        query in interface org.refcodes.structure.PathMap<java.lang.String>
      • query

        default Properties query​(java.lang.Object... aQueryElements)
        Specified by:
        query in interface org.refcodes.structure.CanonicalMap
        Specified by:
        query 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>
      • query

        default Properties query​(java.util.regex.Pattern aRegExp)
        Specified by:
        query in interface org.refcodes.structure.CanonicalMap
        Specified by:
        query in interface org.refcodes.structure.PathMap<java.lang.String>
      • query

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

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

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

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

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

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

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

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

        default Properties queryFrom​(java.lang.Object[] aPathQuery,
                                     java.lang.Object[] aFromPath)
        Specified by:
        queryFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        queryFrom 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>
      • queryFrom

        default Properties queryFrom​(java.util.regex.Pattern aRegExp,
                                     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>
      • 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>
      • queryTo

        default Properties queryTo​(java.util.Collection<?> 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>
      • queryTo

        default Properties queryTo​(java.lang.Object 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>
      • queryTo

        default Properties queryTo​(java.lang.Object[] 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>
      • 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>
      • queryTo

        default Properties queryTo​(java.util.regex.Pattern aRegExp,
                                   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>
      • 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>
      • retrieveBetween

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

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

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

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

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

        default Properties retrieveFrom​(java.util.Collection<?> aPathElements)
        Specified by:
        retrieveFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveFrom in interface org.refcodes.structure.PathMap<java.lang.String>
      • retrieveFrom

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

        default Properties retrieveFrom​(java.lang.Object... aPathElements)
        Specified by:
        retrieveFrom in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveFrom in interface org.refcodes.structure.PathMap<java.lang.String>
      • 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>
      • retrieveFrom

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

        default Properties retrieveTo​(java.util.Collection<?> aToPathElements)
        Specified by:
        retrieveTo in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveTo in interface org.refcodes.structure.PathMap<java.lang.String>
      • retrieveTo

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

        default Properties retrieveTo​(java.lang.Object... aToPathElements)
        Specified by:
        retrieveTo in interface org.refcodes.structure.CanonicalMap
        Specified by:
        retrieveTo 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>
      • retrieveTo

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