Package org.refcodes.structure

Interface PathMap.PathMapBuilder<T>

    • Method Detail

      • withInsertBetween

        default PathMap.PathMapBuilder<T> withInsertBetween​(java.util.Collection<?> aToPathElements,
                                                    PathMap<T> aFrom,
                                                    java.util.Collection<?> aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to insert the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.insertBetween(String, Object, String)

      • withInsertBetween

        default PathMap.PathMapBuilder<T> withInsertBetween​(java.lang.Object[] aToPathElements,
                                                    PathMap<T> aFrom,
                                                    java.lang.Object[] aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to insert the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.insertBetween(String, Object, String)

      • withInsertBetween

        default PathMap.PathMapBuilder<T> withInsertBetween​(java.lang.String[] aToPathElements,
                                                    PathMap<T> aFrom,
                                                    java.lang.String[] aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to insert the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.insertBetween(String, Object, String)

      • withMergeBetween

        default PathMap.PathMapBuilder<T> withMergeBetween​(java.util.Collection<?> aToPathElements,
                                                   PathMap<T> aFrom,
                                                   java.util.Collection<?> aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.mergeBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to merge the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.mergeBetween(String, Object, String)

      • withMergeBetween

        default PathMap.PathMapBuilder<T> withMergeBetween​(java.lang.Object[] aToPathElements,
                                                   PathMap<T> aFrom,
                                                   java.lang.Object[] aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.mergeBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to merge the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.mergeBetween(String, Object, String)

      • withMergeBetween

        default PathMap.PathMapBuilder<T> withMergeBetween​(java.lang.String[] aToPathElements,
                                                   PathMap<T> aFrom,
                                                   java.lang.String[] aFromPathElements)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.mergeBetween(String, Object, String).
        Parameters:
        aToPathElements - The path elements of the sub-path where to merge the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        aFromPathElements - The path elements of the path from where to start adding elements of the provided object.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.mergeBetween(String, Object, String)

      • withMergeTo

        default PathMap.PathMapBuilder<T> withMergeTo​(java.util.Collection<?> aToPathElements,
                                              PathMap<T> aFrom)
        Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.mergeTo(String, Object).
        Parameters:
        aToPathElements - The path elements representing the sub-path where to merge the object's introspected values to.
        aFrom - The PathMap which is to be inspected with the therein contained values being added with their according determined paths.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.
        See Also:
        PathMap.MutablePathMap.mergeTo(String, Object)

      • withPut

        default PathMap.PathMapBuilder<T> withPut​(java.util.Collection<?> aPathElements,
                                          T aValue)
        Builder method for Keys.MutableValues.put(Object, Object).
        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.

      • withPut

        default PathMap.PathMapBuilder<T> withPut​(java.lang.Object[] aPathElements,
                                          T aValue)
        Builder method for Keys.MutableValues.put(Object, Object).
        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.

      • withPut

        default PathMap.PathMapBuilder<T> withPut​(java.lang.String[] aPathElements,
                                          T aValue)
        Builder method for Keys.MutableValues.put(Object, Object).
        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.

      • withPutDirAt

        default PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(java.util.Collection<?> aPathElements,
                                int aIndex,
                                PathMap<T> 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.
        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 PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(int aIndex,
                                PathMap<T> 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.
        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 PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(java.lang.Object aPath,
                                int aIndex,
                                PathMap<T> 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.
        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 PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(java.lang.Object[] aPathElements,
                                int aIndex,
                                PathMap<T> 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.
        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 PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(java.lang.String aPath,
                                int aIndex,
                                PathMap<T> 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.
        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 PathMap<T> 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.
        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 PathMap<T> withPutDirAt​(java.lang.String[] aPathElements,
                                int aIndex,
                                PathMap<T> 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.
        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).

      • withRemoveFrom

        default PathMap.PathMapBuilder<T> withRemoveFrom​(java.util.Collection<?> aPathElements)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPathElements - The path elements of the path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.

      • withRemoveFrom

        default PathMap.PathMapBuilder<T> withRemoveFrom​(java.lang.Object aPath)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPath - The path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.

      • withRemoveFrom

        default PathMap.PathMapBuilder<T> withRemoveFrom​(java.lang.Object... aPathElements)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPathElements - The path elements of the path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.

      • withRemoveFrom

        default PathMap.PathMapBuilder<T> withRemoveFrom​(java.lang.String aPath)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPath - The path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.

      • withRemoveFrom

        default PathMap.PathMapBuilder<T> withRemoveFrom​(java.lang.String... aPathElements)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPathElements - The path elements of the path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.

      • withRemovePaths

        default PathMap.PathMapBuilder<T> withRemovePaths​(java.lang.String... aPathElements)
        Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeFrom( String) method.
        Parameters:
        aPathElements - The path elements of the path from where to remove all properties.
        Returns:
        This instance as of the Builder-Pattern to apply succeeding operations.