Package org.refcodes.structure

Interface CanonicalMap.MutableCanonicalMap

    • Method Detail

      • put

        default java.lang.String put​(Relation<java.lang.String,java.lang.String> aRelation)
        Adds the given element related to the given key.
        Specified by:
        put in interface Dictionary.MutableDictionary<java.lang.String,T>
        Specified by:
        put in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aRelation - the relation
        Returns:
        The value being replaced by the provided value or null if none value has been replaced.

      • delete

        default java.lang.String delete​(java.lang.String aKey)
        Removes an element identified by the given key.
        Specified by:
        delete in interface Keys.MutableKeys<java.lang.String,T>
        Specified by:
        delete in interface PathMap.MutablePathMap<java.lang.String>
        Parameters:
        aKey - The key which's element is to be removed.
        Returns:
        The value being removed.

      • containsValue

        default boolean containsValue​(java.lang.Object value)
        This method is defined for the sake of Map conformity. Tests whether the provided value has a key assigned.
        Specified by:
        containsValue in interface CanonicalMap
        Specified by:
        containsValue in interface Keys<java.lang.String,T>
        Specified by:
        containsValue in interface java.util.Map<java.lang.String,T>
        Parameters:
        value - The value to test if a key references this value.
        Returns:
        True in case the given value is referenced by a key.

      • putAll

        default void putAll​(java.util.Map<? extends java.lang.String,? extends java.lang.String> aProperties)
        Specified by:
        putAll in interface java.util.Map<java.lang.String,T>

      • putAll

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

      • putAll

        default void putAll​(java.util.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.

      • toSourceCode

        default java.lang.String toSourceCode​()
        Beta, don't know whether to keep this or not: Creates a class (a String text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.
        Returns:
        The text representing the source code to be copy'n'pasted.

      • toSourceCode

        default java.lang.String toSourceCode​(java.lang.String aClassName,
                                      java.lang.String aPackage)
        Beta, don't know whether to keep this or not: Creates a class (a String text to be copy'n'pasted) with getters and setters for the herein contained paths and their values.
        Parameters:
        aClassName - The class name for the class to be generated.
        aPackage - The package to which the class is to belong.
        Returns:
        The text representing the source code to be copy'n'pasted.

      • toDump

        default java.util.Map<java.lang.String,java.lang.String> toDump​(java.util.Map<java.lang.String,java.lang.String> aDump)
        Specified by:
        toDump in interface org.refcodes.mixin.Dumpable

      • insert

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

      • insertFrom

        default void insertFrom​(CanonicalMap aFrom,
                        java.lang.String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertFrom(Object, String).
        Parameters:
        aFrom - The CanonicalMap 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​(java.lang.String aToPath,
                      CanonicalMap 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 CanonicalMap which is to be inspected with the therein contained values being added with their according determined paths.

      • insert

        default void insert​(java.lang.String aToPath,
                    CanonicalMap aFrom,
                    java.lang.String aFromPath)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(String, Object, String).
        Parameters:
        aToPath - The sub-path where to insert the object's introspected values to.
        aFrom - The CanonicalMap 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.