Module org.refcodes.properties
Package org.refcodes.properties

Interface Properties.MutableProperties

    • 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.struct.Dictionary

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

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

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

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

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default boolean containsValue​(Object value)
      default String delete​(org.refcodes.struct.Property aProperty)
      Removes a property identified by the key of the provided Property (the value of the Property is ignored).
      default void insert​(Properties aFrom)
      Method to semantically emphasize that we support our own types.
      default void insertBetween​(String aToPath, Properties aFrom, String aFromPath)
      Method to semantically emphasize that we support our own types.
      default void insertFrom​(Properties aFrom, String aFromPath)
      Method to semantically emphasize that we support our own types.
      default void insertTo​(String aToPath, Properties aFrom)
      Method to semantically emphasize that we support our own types.
      default String put​(org.refcodes.struct.Relation<String,​String> aRelation)
      default void putAll​(Map<? extends String,​? extends String> aProperties)
      default void putAll​(Properties aProperties)
      This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
      default void putAll​(Properties aProperties)
      This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
      default Properties putDirAt​(int aIndex, Object aDir)
      default Properties putDirAt​(int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties putDirAt​(Object[] aPathElements, int aIndex, Object aDir)
      default Properties putDirAt​(Object[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties putDirAt​(Object aPath, int aIndex, Object aDir)
      default Properties putDirAt​(Object aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties putDirAt​(String[] aPathElements, int aIndex, Object aDir)
      default Properties putDirAt​(String[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties putDirAt​(String aPath, int aIndex, Object aDir)
      default Properties putDirAt​(String aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties putDirAt​(Collection<?> aPathElements, int aIndex, Object aDir)
      default Properties putDirAt​(Collection<?> aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
      default Properties removeAll​(Object aPathQuery)
      default Properties removeAll​(Object... aPathQueryElemments)
      default Properties removeAll​(String aPathQuery)
      default Properties removeAll​(String... aPathQueryElemments)
      default Properties removeAll​(Collection<?> aPathQueryElemments)
      default Properties removeAll​(Pattern aRegExp)
      default Properties removeDirAt​(int aIndex)
      default Properties removeDirAt​(Object[] aPathElements, int aIndex)
      default Properties removeDirAt​(Object aPath, int aIndex)
      default Properties removeDirAt​(String[] aPathElements, int aIndex)
      default Properties removeDirAt​(String aPath, int aIndex)
      default Properties removeFrom​(Object aPath)
      default Properties removeFrom​(Object... aPathElements)
      default Properties removeFrom​(String aPath)
      default Properties removeFrom​(String... aPathElements)
      default Properties removePaths​(String... aPaths)
      default Properties removePaths​(Collection<?> aPaths)

      • Methods inherited from interface org.refcodes.struct.CanonicalMap

        asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

      • Methods inherited from interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap

        insert, insertBetween, insertFrom, insertTo, put, put, put, put, putAll, removeFrom, toDump

      • Methods inherited from interface org.refcodes.mixin.Clearable

        clear

      • Methods inherited from interface org.refcodes.struct.Containable

        size

      • Methods inherited from interface org.refcodes.mixin.Dumpable

        toDump, toPrintable

      • Methods inherited from interface org.refcodes.mixin.EmptyAccessor

        isEmpty

      • Methods inherited from interface org.refcodes.struct.InterOperableMap

        getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

      • Methods inherited from interface org.refcodes.struct.InterOperableMap.MutableInterOperableMap

        insert, insertBetween, insertFrom, insertTo, putBoolean, putBoolean, putBoolean, putBoolean, putBoolean, putByte, putByte, putByte, putByte, putByte, putChar, putChar, putChar, putChar, putChar, putClass, putClass, putClass, putClass, putClass, putDouble, putDouble, putDouble, putDouble, putDouble, putEnum, putEnum, putEnum, putEnum, putEnum, putFloat, putFloat, putFloat, putFloat, putFloat, putInt, putInt, putInt, putInt, putInt, putLong, putLong, putLong, putLong, putLong, putShort, putShort, putShort, putShort, putShort, putString, putString, putString, putString, putString

      • Methods inherited from interface org.refcodes.struct.Keys

        containsKey, get, getOr, keySet, use, values

      • Methods inherited from interface org.refcodes.struct.Keys.MutableValues

        put

      • Methods inherited from interface org.refcodes.struct.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, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, 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, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, 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, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

      • Methods inherited from interface org.refcodes.struct.PathMap.MutablePathMap

        add, add, add, add, add, add, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, delete, delete, delete, delete, delete, insert, insert, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, merge, merge, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, put, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, remove, remove, remove, removeValueAt, removeValueAt, removeValueAt, removeValueAt, removeValueAt, toSourceCode, toSourceCode

    • Method Detail

      • containsValue

        default boolean containsValue​(Object value)
        Specified by:
        containsValue in interface org.refcodes.struct.CanonicalMap
        Specified by:
        containsValue in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        containsValue in interface org.refcodes.struct.InterOperableMap.MutableInterOperableMap<String>
        Specified by:
        containsValue in interface org.refcodes.struct.Keys<String,​String>
        Specified by:
        containsValue in interface Map<String,​String>
        Specified by:
        containsValue in interface Properties

      • delete

        default String delete​(org.refcodes.struct.Property aProperty)
        Removes a property identified by the key of the provided Property (the value of the Property is ignored).
        Parameters:
        aProperty - The Property which's key is to be removed.
        Returns:
        The removed value of the key or null if there was not such a key.

      • insert

        default void insert​(Properties aFrom)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(Object).
        Parameters:
        aFrom - The Properties which is to be inspected with the therein contained values being added with their according determined paths.

      • insertBetween

        default void insertBetween​(String aToPath,
                           Properties aFrom,
                           String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).
        Parameters:
        aToPath - The sub-path where to insert the object's introspected values to.
        aFrom - The Properties which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPath - The path from where to start adding elements of the provided object.

      • insertFrom

        default void insertFrom​(Properties aFrom,
                        String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertFrom(Object, String).
        Parameters:
        aFrom - The Properties which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPath - The path from where to start adding elements of the provided object.

      • insertTo

        default void insertTo​(String aToPath,
                      Properties aFrom)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertTo(String, Object).
        Parameters:
        aToPath - The sub-path where to insert the object's introspected values to.
        aFrom - The Properties which is to be inspected with the therein contained values being added with their according determined paths.

      • put

        default String put​(org.refcodes.struct.Relation<String,​String> aRelation)
        Specified by:
        put in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        put in interface org.refcodes.struct.Dictionary.MutableDictionary<String,​String>
        Specified by:
        put in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • putAll

        default void putAll​(Properties aProperties)
        This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
        Specified by:
        putAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Parameters:
        aProperties - A Properties containing the key/value-pairs to be inserted.

      • putAll

        default void putAll​(Map<? extends String,​? extends String> aProperties)
        Specified by:
        putAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        putAll in interface Map<String,​String>

      • putAll

        default void putAll​(Properties aProperties)
        This method inserts all elements (key/value-pairs) found in the provided Properties instances of interoperability reasons.
        Parameters:
        aProperties - A Properties containing the key/value pairs to be inserted.

      • removePaths

        default Properties removePaths​(Collection<?> aPaths)
        Specified by:
        removePaths in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removePaths in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removePaths

        default Properties removePaths​(String... aPaths)
        Specified by:
        removePaths in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removePaths in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(String... aPathQueryElemments)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(Object... aPathQueryElemments)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(Collection<?> aPathQueryElemments)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(String aPathQuery)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(Pattern aRegExp)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeAll

        default Properties removeAll​(Object aPathQuery)
        Specified by:
        removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeDirAt

        default Properties removeDirAt​(int aIndex)
        Specified by:
        removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeDirAt

        default Properties removeDirAt​(Object aPath,
                               int aIndex)
        Specified by:
        removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeDirAt

        default Properties removeDirAt​(Object[] aPathElements,
                               int aIndex)
        Specified by:
        removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeDirAt

        default Properties removeDirAt​(String aPath,
                               int aIndex)
        Specified by:
        removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeDirAt

        default Properties removeDirAt​(String[] aPathElements,
                               int aIndex)
        Specified by:
        removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeFrom

        default Properties removeFrom​(Object... aPathElements)
        Specified by:
        removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeFrom

        default Properties removeFrom​(Object aPath)
        Specified by:
        removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeFrom

        default Properties removeFrom​(String aPath)
        Specified by:
        removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>

      • removeFrom

        default Properties removeFrom​(String... aPathElements)
        Specified by:
        removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
        Specified by:
        removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>