org.refcodes.structure

Interface PathMap.PathMapBuilder<T>

Type Parameters:

T - The type of the terminating elements.

All Superinterfaces:

Clearable, Containable, org.refcodes.mixin.DelimiterAccessor, Dictionary<String,T>, Dictionary.MutableDictionary<String,T>, Dictionary.MutableDictionary.DictionaryBuilder<String,T,PathMap.PathMapBuilder<T>>, org.refcodes.mixin.Dumpable, Keys<String,T>, Keys.MutableKeys<String,T>, Keys.MutableValues<String,T>, Map<String,T>, PathMap<T>, PathMap.MutablePathMap<T>, org.refcodes.mixin.TypeAccessor<T>

All Known Subinterfaces:

CanonicalMap.CanonicalMapBuilder

All Known Implementing Classes:

CanonicalMapBuilderImpl, PathMapBuilderImpl

Enclosing interface:

PathMap<T>

public static interface PathMap.PathMapBuilder<T>
extends PathMap.MutablePathMap<T>, Dictionary.MutableDictionary.DictionaryBuilder<String,T,PathMap.PathMapBuilder<T>>

Extends the PathMap with mutator functionality.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.structure.PathMap

PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>

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.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

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

Dictionary.MutableDictionary.DictionaryBuilder<K,V,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.structure.Dictionary

Dictionary.MutableDictionary<K,V>

Method Summary

Modifier and Type	Method and Description
default PathMap.PathMapBuilder<T>	withInsert(Object aObj) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(Object) method.
default PathMap.PathMapBuilder<T>	withInsert(PathMap<T> aFrom) Method to semantically emphasize that we support our own types.
default PathMap.PathMapBuilder<T>	withInsert(String aToPath, Object aFrom, String aFromPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(String, Object, String) method.
default PathMap.PathMapBuilder<T>	withInsert(String aToPath, PathMap<T> aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default PathMap.PathMapBuilder<T>	withInsertFrom(Object aFrom, String aFromPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertFrom(Object, String) method.
default PathMap.PathMapBuilder<T>	withInsertFrom(PathMap<T> aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default PathMap.PathMapBuilder<T>	withInsertTo(String aToPath, Object aFrom) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertTo(String, Object) method.
default PathMap.PathMapBuilder<T>	withInsertTo(String aToPath, PathMap<T> aFrom) Method to semantically emphasize that we support our own types.
default PathMap.PathMapBuilder<T>	withPut(Relation<String,T> aRelation) Builder method for Dictionary.MutableDictionary.put(Relation).
default PathMap.PathMapBuilder<T>	withPut(String aKey, T aValue) Builder method for Keys.MutableValues.put(Object, Object).
default PathMap.PathMapBuilder<T>	withRemoveFrom(String aPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeAll( String) method.

Methods inherited from interface org.refcodes.structure.PathMap.MutablePathMap

delete, insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, put, put, putArray, putArray, removeAll

Methods inherited from interface org.refcodes.structure.PathMap

directories, directories, entries, entries, fromExternalKey, getArray, getArray, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, retrieve, retrieveFrom, retrieveTo, toDataStructure, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toRootPath

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.structure.Keys.MutableValues

put

Methods inherited from interface org.refcodes.structure.Clearable

clear

Method Detail

withPut

default PathMap.PathMapBuilder<T> withPut(String aKey,
                                          T aValue)

Builder method for Keys.MutableValues.put(Object, Object).

Specified by:

withPut in interface Dictionary.MutableDictionary.DictionaryBuilder<String,T,PathMap.PathMapBuilder<T>>

Parameters:

aKey - the key 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(Relation<String,T> aRelation)

Builder method for Dictionary.MutableDictionary.put(Relation).

Specified by:

withPut in interface Dictionary.MutableDictionary.DictionaryBuilder<String,T,PathMap.PathMapBuilder<T>>

Parameters:

aRelation - the property to be put.

Returns:

The implementing instance as of the builder pattern.

withRemoveFrom

default PathMap.PathMapBuilder<T> withRemoveFrom(String aPath)

Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeAll( String) method.

Parameters:

aPath - The path from where to remove all properties.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

withInsert

default PathMap.PathMapBuilder<T> withInsert(Object aObj)

Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(Object) method.

Parameters:

aObj - the a obj

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insert(Object)

withInsertFrom

default PathMap.PathMapBuilder<T> withInsertFrom(Object aFrom,
                                                 String aFromPath)

Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertFrom(Object, String) method.

Parameters:

aFrom - the a from

aFromPath - the a from path

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insertFrom(Object, String)

withInsertTo

default PathMap.PathMapBuilder<T> withInsertTo(String aToPath,
                                               Object aFrom)

Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertTo(String, Object) method.

Parameters:

aToPath - the a to path

aFrom - the a from

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insertTo(String, Object)

withInsert

default PathMap.PathMapBuilder<T> withInsert(String aToPath,
                                             Object aFrom,
                                             String aFromPath)

Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(String, Object, String) method.

Parameters:

aToPath - the a to path

aFrom - the a from

aFromPath - the a from path

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insert(String, Object, String)

withInsert

default PathMap.PathMapBuilder<T> withInsert(PathMap<T> aFrom)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insert(Object).

Parameters:

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.insert(Object)

withInsertFrom

default PathMap.PathMapBuilder<T> withInsertFrom(PathMap<T> aFrom,
                                                 String aFromPath)

Method to semantically emphasize that we support our own types. Actually delegates to PathMap.MutablePathMap.insertFrom(Object, String).

Parameters:

aFrom - The PathMap 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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insertFrom(Object, String)

withInsertTo

default PathMap.PathMapBuilder<T> withInsertTo(String aToPath,
                                               PathMap<T> 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 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.insertTo(String, Object)

withInsert

default PathMap.PathMapBuilder<T> withInsert(String aToPath,
                                             PathMap<T> aFrom,
                                             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 PathMap 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.

Returns:

This instance as of the Builder-Pattern to apply succeeding operations.

See Also:

PathMap.MutablePathMap.insert(String, Object, String)