Package org.refcodes.structure

Class PathMapBuilderImpl<T>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,T>

org.refcodes.structure.PathMapBuilderImpl<T>

Type Parameters:

T - the generic type of the elements to be contained herein.

All Implemented Interfaces:

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

Direct Known Subclasses:

CanonicalMapBuilderImpl

public class PathMapBuilderImpl<T>
extends java.util.HashMap<java.lang.String,T>
implements PathMap.PathMapBuilder<T>

The Class PathMapBuilderImpl.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,V extends java.lang.Object>

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.structure.Dictionary

Dictionary.MutableDictionary<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 java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

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

org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

Constructor Summary

Constructors

Constructor	Description
PathMapBuilderImpl(char aDelimiter, java.lang.Class<T> aType)	Create a PathMap.PathMapBuilder instance using the provided path delimiter for the path declarations.
PathMapBuilderImpl(java.lang.Class<T> aType)	Create an empty PathMap.PathMapBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
PathMapBuilderImpl(java.lang.Object aObj, char aDelimiter, java.lang.Class<T> aType)	Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
PathMapBuilderImpl(java.lang.Object aObj, java.lang.Class<T> aType)	Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
PathMapBuilderImpl(java.lang.Object aObj, java.lang.String aFromPath, char aDelimiter, java.lang.Class<T> aType)	Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
PathMapBuilderImpl(java.lang.Object aObj, java.lang.String aFromPath, java.lang.Class<T> aType)	Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
PathMapBuilderImpl(java.lang.String aToPath, java.lang.Object aObj, char aDelimiter, java.lang.Class<T> aType)	Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
PathMapBuilderImpl(java.lang.String aToPath, java.lang.Object aObj, java.lang.Class<T> aType)	Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.
PathMapBuilderImpl(java.lang.String aToPath, java.lang.Object aObj, java.lang.String aFromPath, char aDelimiter, java.lang.Class<T> aType)	Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).
PathMapBuilderImpl(java.lang.String aToPath, java.lang.Object aObj, java.lang.String aFromPath, java.lang.Class<T> aType)	Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.

Method Summary

Modifier and Type	Method	Description
T	compute(java.lang.String aPath, java.util.function.BiFunction<? super java.lang.String,? super T,? extends T> remappingFunction)
T	computeIfAbsent(java.lang.String aPath, java.util.function.Function<? super java.lang.String,? extends T> mappingFunction)
T	computeIfPresent(java.lang.String aPath, java.util.function.BiFunction<? super java.lang.String,? super T,? extends T> remappingFunction)
boolean	containsKey(java.lang.Object aPath)	Tests whether there is an element with the given key.
T	get(java.lang.Object aPath)	Retrieves the element assigned to the given key.
char	getDelimiter()
T	getOrDefault(java.lang.Object aPath, T publicValue)
java.lang.Class<T>	getType()
T	merge(java.lang.String aPath, T value, java.util.function.BiFunction<? super T,? super T,? extends T> remappingFunction)
T	put(java.lang.String aPath, T value)	Puts an element identified by the given key.
T	putIfAbsent(java.lang.String aPath, T value)
T	remove(java.lang.Object aPath)
boolean	remove(java.lang.Object aPath, java.lang.Object value)
T	replace(java.lang.String aPath, T value)
boolean	replace(java.lang.String aPath, T oldValue, T newValue)
PathMap<T>	retrieveFrom(java.lang.String aFromPath)	Extracts a new PathMap from the elements of this PathMap found below the "from-path".
PathMap<T>	retrieveTo(java.lang.String aToPath)	Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path".
java.lang.Object	toDataStructure(java.lang.String aFromPath)	Similar to the PathMap.toMap(String) method, though in case all the keys of a nested Map instance (applicable to the root Map as well) represent an array (as of PathMap.getArray( String)), then an array is generated where the index of each value in the Map is represented by the number representation of the Map's key for that value.

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from interface org.refcodes.structure.Clearable

clear

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from class java.util.HashMap

clear, clone, containsValue, entrySet, forEach, isEmpty, keySet, putAll, replaceAll, size, values

Methods inherited from interface java.util.Map

clear, containsValue, entry, entrySet, equals, forEach, hashCode, isEmpty, keySet, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putAll, replaceAll, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.structure.PathMap

children, children, children, directories, directories, directories, directories, directories, fromExternalKey, get, get, getArray, getArray, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getIndexed, getIndexed, getIndexes, getIndexes, getInteger, getInteger, getLong, getLong, getRootPath, getShort, getShort, hasChildren, hasChildren, hasChildren, hasIndexed, hasIndexed, hasParentPath, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isDirectory, isDirectory, isDirectory, isDirectory, isIndexed, isIndexed, isPath, isRecord, isRecord, isRecord, isRecord, isRootPath, keySet, paths, paths, paths, paths, paths, query, query, queryFrom, queryPaths, queryTo, records, records, records, records, records, retrieve, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath, toPath

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

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

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

withInsert, withInsert, withInsert, withInsert, withInsertFrom, withInsertFrom, withInsertTo, withInsertTo, withPut, withPut, withRemoveFrom

Constructor Detail

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.Class<T> aType)

Create an empty PathMap.PathMapBuilder instance using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(char aDelimiter,
                          java.lang.Class<T> aType)

Create a PathMap.PathMapBuilder instance using the provided path delimiter for the path declarations.

Parameters:

aDelimiter - The path delimiter to be used for the path declarations.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.Object aObj,
                          java.lang.Class<T> aType)

Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aObj - The object from which the elements are to be added.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.String aToPath,
                          java.lang.Object aObj,
                          java.lang.Class<T> aType)

Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aObj - The object from which the elements are to be added.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.Object aObj,
                          java.lang.String aFromPath,
                          java.lang.Class<T> aType)

Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH) for the path declarations.

Parameters:

aObj - The object from which the elements are to be added.

aFromPath - The path from where to start adding elements of the provided object.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.String aToPath,
                          java.lang.Object aObj,
                          java.lang.String aFromPath,
                          java.lang.Class<T> aType)

Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the default path delimiter "/" (Delimiter.PATH for the path declarations.

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aObj - The object from which the elements are to be added.

aFromPath - The path from where to start adding elements of the provided object.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.Object aObj,
                          char aDelimiter,
                          java.lang.Class<T> aType)

Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).

Parameters:

aObj - The object from which the elements are to be added.

aDelimiter - The path delimiter to be used for the path declarations.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.String aToPath,
                          java.lang.Object aObj,
                          char aDelimiter,
                          java.lang.Class<T> aType)

Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aObj - The object from which the elements are to be added.

aDelimiter - The path delimiter to be used for the path declarations.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.Object aObj,
                          java.lang.String aFromPath,
                          char aDelimiter,
                          java.lang.Class<T> aType)

Creates a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).

Parameters:

aObj - The object from which the elements are to be added.

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

aType - The type of the values being referenced by the paths.

PathMapBuilderImpl

public PathMapBuilderImpl(java.lang.String aToPath,
                          java.lang.Object aObj,
                          java.lang.String aFromPath,
                          char aDelimiter,
                          java.lang.Class<T> aType)

Create a PathMap.PathMapBuilder instance containing the elements as of PathMap.MutablePathMap.insert(Object).

Parameters:

aToPath - The sub-path where to insert the object's introspected values to.

aObj - The object from which the elements are to be added.

aFromPath - The path from where to start adding elements of the provided object.

aDelimiter - The path delimiter to be used for the path declarations.

aType - The type of the values being referenced by the paths.

Method Detail

containsKey

public boolean containsKey(java.lang.Object aPath)

Tests whether there is an element with the given key.

Specified by:

containsKey in interface Keys<K,V>

Specified by:

containsKey in interface java.util.Map<java.lang.String,T>

Overrides:

containsKey in class java.util.HashMap<java.lang.String,T>

Parameters:

aPath - The key for which to test whether there is an element.

Returns:

True in case there is an element for the given key.

get

public T get(java.lang.Object aPath)

Retrieves the element assigned to the given key.

Specified by:

get in interface Keys<K,V>

Specified by:

get in interface java.util.Map<java.lang.String,T>

Overrides:

get in class java.util.HashMap<java.lang.String,T>

Parameters:

aPath - The key for which to get the element.

Returns:

The column in question or null if there is none such column.

put

public T put(java.lang.String aPath,
             T value)

Puts an element identified by the given key.

Specified by:

put in interface Keys.MutableValues<K,V>

Specified by:

put in interface java.util.Map<java.lang.String,T>

Overrides:

put in class java.util.HashMap<java.lang.String,T>

Parameters:

aPath - The key which's element is to be put.

value - the value

Returns:

The value being overwritten.

remove

public T remove(java.lang.Object aPath)

Specified by:

remove in interface java.util.Map<java.lang.String,T>

Overrides:

remove in class java.util.HashMap<java.lang.String,T>

getOrDefault

public T getOrDefault(java.lang.Object aPath,
                      T publicValue)

Specified by:

getOrDefault in interface java.util.Map<java.lang.String,T>

Overrides:

getOrDefault in class java.util.HashMap<java.lang.String,T>

putIfAbsent

public T putIfAbsent(java.lang.String aPath,
                     T value)

Specified by:

putIfAbsent in interface java.util.Map<java.lang.String,T>

Overrides:

putIfAbsent in class java.util.HashMap<java.lang.String,T>

remove

public boolean remove(java.lang.Object aPath,
                      java.lang.Object value)

Specified by:

remove in interface java.util.Map<java.lang.String,T>

Overrides:

remove in class java.util.HashMap<java.lang.String,T>

replace

public boolean replace(java.lang.String aPath,
                       T oldValue,
                       T newValue)

Specified by:

replace in interface java.util.Map<java.lang.String,T>

Overrides:

replace in class java.util.HashMap<java.lang.String,T>

replace

public T replace(java.lang.String aPath,
                 T value)

Specified by:

replace in interface java.util.Map<java.lang.String,T>

Overrides:

replace in class java.util.HashMap<java.lang.String,T>

computeIfAbsent

public T computeIfAbsent(java.lang.String aPath,
                         java.util.function.Function<? super java.lang.String,? extends T> mappingFunction)

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.String,T>

Overrides:

computeIfAbsent in class java.util.HashMap<java.lang.String,T>

computeIfPresent

public T computeIfPresent(java.lang.String aPath,
                          java.util.function.BiFunction<? super java.lang.String,? super T,? extends T> remappingFunction)

Specified by:

computeIfPresent in interface java.util.Map<java.lang.String,T>

Overrides:

computeIfPresent in class java.util.HashMap<java.lang.String,T>

compute

public T compute(java.lang.String aPath,
                 java.util.function.BiFunction<? super java.lang.String,? super T,? extends T> remappingFunction)

Specified by:

compute in interface java.util.Map<java.lang.String,T>

Overrides:

compute in class java.util.HashMap<java.lang.String,T>

merge

public T merge(java.lang.String aPath,
               T value,
               java.util.function.BiFunction<? super T,? super T,? extends T> remappingFunction)

Specified by:

merge in interface java.util.Map<java.lang.String,T>

Overrides:

merge in class java.util.HashMap<java.lang.String,T>

retrieveTo

public PathMap<T> retrieveTo(java.lang.String aToPath)

Extracts a new PathMap from this PathMap's elements with the paths relocated to the provided "to-path". Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveTo(String) with "/animals", then the resulting PathMap will contain the path "/animals/dog/cat" for that value.

Specified by:

retrieveTo in interface PathMap<T>

Parameters:

aToPath - The path where to relocate the paths of this PathMap to.

Returns:

The PathMap with the elements from the provided PathMap with accordingly relocated paths.

retrieveFrom

public PathMap<T> retrieveFrom(java.lang.String aFromPath)

Extracts a new PathMap from the elements of this PathMap found below the "from-path". The sub-paths will be the root paths for the new PathMap. Given we have a value for path "/dog/cat" in the PathMap and we call PathMap.retrieveFrom(String) with "/dog", then the resulting PathMap will contain the path "/cat" for that value.

Specified by:

retrieveFrom in interface PathMap<T>

Parameters:

aFromPath - The path from where to start extracting the paths.

Returns:

The PathMap with the elements below the provided path which are root elements in the new PathMap.

getDelimiter

public char getDelimiter()

Specified by:

getDelimiter in interface org.refcodes.mixin.DelimiterAccessor

getType

public java.lang.Class<T> getType()

Specified by:

getType in interface org.refcodes.mixin.TypeAccessor<T>

toDataStructure

public java.lang.Object toDataStructure(java.lang.String aFromPath)

Similar to the PathMap.toMap(String) method, though in case all the keys of a nested Map instance (applicable to the root Map as well) represent an array (as of PathMap.getArray( String)), then an array is generated where the index of each value in the Map is represented by the number representation of the Map's key for that value. The result is a data structure consisting of Map instances and arrays.

Specified by:

toDataStructure in interface PathMap<T>

Parameters:

aFromPath - The path below which the PathMap to be converted into a data structure.

Returns:

A data structure being a mixture of Map instances and arrays representing the data below the given path.