Package org.refcodes.structure

Interface CanonicalMap.CanonicalMapBuilder

    • Method Detail

      • withPut

        default CanonicalMap.CanonicalMapBuilder withPut​(java.lang.Object[] aPathElements,
                                                 java.lang.String aValue)
                                          throws java.lang.NumberFormatException
        Builder method for Keys.MutableValues.put(Object, Object).
        Specified by:
        withPut in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - the path elements for the property to be put.
        aValue - the value for the property to be put.
        Returns:
        The implementing instance as of the builder pattern.
        Throws:
        java.lang.NumberFormatException

      • withPutBoolean

        default CanonicalMap.CanonicalMapBuilder withPutBoolean​(java.util.Collection<?> aPathElements,
                                                        java.lang.Boolean aValue)
        Sets the Boolean value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Boolean value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Boolean value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutBoolean

        default CanonicalMap.CanonicalMapBuilder withPutBoolean​(java.lang.Object[] aPathElements,
                                                        java.lang.Boolean aValue)
        Sets the Boolean value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Boolean value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Boolean to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutBoolean

        default CanonicalMap.CanonicalMapBuilder withPutBoolean​(java.lang.String[] aPathElements,
                                                        java.lang.Boolean aValue)
        Sets the Boolean value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Boolean value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Boolean value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutByte

        default CanonicalMap.CanonicalMapBuilder withPutByte​(java.util.Collection<?> aPathElements,
                                                     java.lang.Byte aValue)
        Sets the Byte value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Byte value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Byte value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutByte

        default CanonicalMap.CanonicalMapBuilder withPutByte​(java.lang.Object[] aPathElements,
                                                     java.lang.Byte aValue)
        Sets the Byte value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Byte value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Byte to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutByte

        default CanonicalMap.CanonicalMapBuilder withPutByte​(java.lang.String[] aPathElements,
                                                     java.lang.Byte aValue)
        Sets the Byte value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Byte value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Byte value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.util.Collection<?> aPathElements,
                                  int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.util.Collection<?> aPathElements,
                                  int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the root path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.Object aPath,
                                  int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.Object aPath,
                                  int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.Object[] aPathElements,
                                  int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.Object[] aPathElements,
                                  int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.String aPath,
                                  int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.String aPath,
                                  int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPath - The path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.String[] aPathElements,
                                  int aIndex,
                                  java.lang.Object aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDirAt

        default CanonicalMap withPutDirAt​(java.lang.String[] aPathElements,
                                  int aIndex,
                                  PathMap<java.lang.String> aDir)
                           throws java.lang.IllegalArgumentException
        An indexed directory represents all elements which begin with a path which's last path element represents an index. There may by many sub-paths for the same indexed path which are all are included by the according directory. Puts the given values below the path at the given index.
        Specified by:
        withPutDirAt in interface PathMap.PathMapBuilder<java.lang.String>
        Parameters:
        aPathElements - The path elements of the path where to put the indexed element.
        aIndex - The index of the indexed element.
        aDir - The values to be put at the index.
        Returns:
        This instance (on which the method call has been invoked) as of the builder pattern.
        Throws:
        java.lang.IllegalArgumentException - in case the path does not represent indexed elements as of PathMap.isDirIndex(String).

      • withPutDouble

        default CanonicalMap.CanonicalMapBuilder withPutDouble​(java.util.Collection<?> aPathElements,
                                                       java.lang.Double aValue)
        Sets the Double value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Double value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Double value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutDouble

        default CanonicalMap.CanonicalMapBuilder withPutDouble​(java.lang.Object[] aPathElements,
                                                       java.lang.Double aValue)
        Sets the Double value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Double value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Double to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutDouble

        default CanonicalMap.CanonicalMapBuilder withPutDouble​(java.lang.String[] aPathElements,
                                                       java.lang.Double aValue)
        Sets the Double value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Double value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Double value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutFloat

        default CanonicalMap.CanonicalMapBuilder withPutFloat​(java.util.Collection<?> aPathElements,
                                                      java.lang.Float aValue)
        Sets the Float value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Float value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Float value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutFloat

        default CanonicalMap.CanonicalMapBuilder withPutFloat​(java.lang.Object[] aPathElements,
                                                      java.lang.Float aValue)
        Sets the Float value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Float value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Float to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutFloat

        default CanonicalMap.CanonicalMapBuilder withPutFloat​(java.lang.String[] aPathElements,
                                                      java.lang.Float aValue)
        Sets the Float value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Float value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Float value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutInteger

        default CanonicalMap.CanonicalMapBuilder withPutInteger​(java.util.Collection<?> aPathElements,
                                                        java.lang.Integer aValue)
        Sets the Integer value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Integer value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Integer value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutInteger

        default CanonicalMap.CanonicalMapBuilder withPutInteger​(java.lang.Object[] aPathElements,
                                                        java.lang.Integer aValue)
        Sets the Integer value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Integer value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Integer to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutInteger

        default CanonicalMap.CanonicalMapBuilder withPutInteger​(java.lang.String[] aPathElements,
                                                        java.lang.Integer aValue)
        Sets the Integer value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Integer value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Integer value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutLong

        default CanonicalMap.CanonicalMapBuilder withPutLong​(java.util.Collection<?> aPathElements,
                                                     java.lang.Long aValue)
        Sets the Long value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Long value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Long value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutLong

        default CanonicalMap.CanonicalMapBuilder withPutLong​(java.lang.Object[] aPathElements,
                                                     java.lang.Long aValue)
        Sets the Long value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Long value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Long to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutLong

        default CanonicalMap.CanonicalMapBuilder withPutLong​(java.lang.String[] aPathElements,
                                                     java.lang.Long aValue)
        Sets the Long value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Long value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Long value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutShort

        default CanonicalMap.CanonicalMapBuilder withPutShort​(java.util.Collection<?> aPathElements,
                                                      java.lang.Short aValue)
        Sets the Short value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Short value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Short value to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutShort

        default CanonicalMap.CanonicalMapBuilder withPutShort​(java.lang.Object[] aPathElements,
                                                      java.lang.Short aValue)
        Sets the Short value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Short value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The value Short to be associated with the path.
        Returns:
        This instance for further builder method calls.

      • withPutShort

        default CanonicalMap.CanonicalMapBuilder withPutShort​(java.lang.String[] aPathElements,
                                                      java.lang.Short aValue)
        Sets the Short value for the property referred to by the path elements representing the addressed path. As property keys and values are of type String, the Short value is converted accordingly.
        Parameters:
        aPathElements - The path elements of the path addressing the value.
        aValue - The Short value to be associated with the path.
        Returns:
        This instance for further builder method calls.