org.refcodes.structure

Interface CanonicalMap.CanonicalMapBuilder

All Superinterfaces:

CanonicalMap, CanonicalMap.MutableCanonicalMap, Clearable, Containable, org.refcodes.mixin.DelimiterAccessor, Dictionary<String,String>, Dictionary.MutableDictionary<String,String>, Dictionary.MutableDictionary.DictionaryBuilder<String,String,PathMap.PathMapBuilder<String>>, org.refcodes.mixin.Dumpable, Keys<String,String>, Keys.MutableKeys<String,String>, Keys.MutableValues<String,String>, Map<String,String>, PathMap<String>, PathMap.MutablePathMap<String>, PathMap.PathMapBuilder<String>, PropertiesAccessorMixin, PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin, org.refcodes.mixin.TypeAccessor<String>

All Known Implementing Classes:

CanonicalMapBuilderImpl

Enclosing interface:

CanonicalMap

public static interface CanonicalMap.CanonicalMapBuilder
extends PathMap.PathMapBuilder<String>, CanonicalMap.MutableCanonicalMap, PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

The Interface CanonicalMapBuilder.

Nested Class Summary

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

CanonicalMap.CanonicalMapBuilder, CanonicalMap.MutableCanonicalMap

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

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

Map.Entry<K,V>

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

PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin

Field Summary

Fields inherited from interface org.refcodes.structure.CanonicalMap

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method and Description
default CanonicalMap.CanonicalMapBuilder	withInsert(CanonicalMap aFrom) Method to semantically emphasize that we support our own types.
default CanonicalMap.CanonicalMapBuilder	withInsert(Object aObj) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(Object) method.
default CanonicalMap.CanonicalMapBuilder	withInsert(String aToPath, CanonicalMap aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default CanonicalMap.CanonicalMapBuilder	withInsert(String aToPath, Object aFrom, String aFromPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insert(String, Object, String) method.
default CanonicalMap.CanonicalMapBuilder	withInsertFrom(CanonicalMap aFrom, String aFromPath) Method to semantically emphasize that we support our own types.
default CanonicalMap.CanonicalMapBuilder	withInsertFrom(Object aFrom, String aFromPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertFrom(Object, String) method.
default CanonicalMap.CanonicalMapBuilder	withInsertTo(String aToPath, CanonicalMap aFrom) Method to semantically emphasize that we support our own types.
default CanonicalMap.CanonicalMapBuilder	withInsertTo(String aToPath, Object aFrom) Convenience method for providing builder functionality to the PathMap.MutablePathMap.insertTo(String, Object) method.
default CanonicalMap.CanonicalMapBuilder	withPut(Relation<String,String> aProperty) Builder method for Dictionary.MutableDictionary.put(Relation).
default CanonicalMap.CanonicalMapBuilder	withPut(String aKey, String aValue) Builder method for Keys.MutableValues.put(Object, Object).
default CanonicalMap.CanonicalMapBuilder	withPutBoolean(String aKey, Boolean aValue) Sets the Boolean value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutByte(String aKey, Byte aValue) Sets the Byte value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutDouble(String aKey, Double aValue) Sets the Double value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutFloat(String aKey, Float aValue) Sets the Float value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutInteger(String aKey, Integer aValue) Sets the Integer value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutLong(String aKey, Long aValue) Sets the Long value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withPutShort(String aKey, Short aValue) Sets the Short value for the property referred to by the key.
default CanonicalMap.CanonicalMapBuilder	withRemoveFrom(String aPath) Convenience method for providing builder functionality to the PathMap.MutablePathMap.removeAll( String) method.

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

withInsert, withInsert, withInsertFrom, withInsertTo

Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap

containsValue, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll, toDump, toSourceCode

Methods inherited from interface org.refcodes.structure.CanonicalMap

retrieve, retrieveFrom, retrieveTo, toInstance, toInstance, toType, toType

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

insert, insert, insert, insert, insertFrom, insertFrom, insertTo, insertTo, 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, 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

Methods inherited from interface org.refcodes.structure.Containable

isEmpty, size

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesBuilderMixin

withPut

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin

containsKey, get, getBoolean, getBoolean, getByte, getByte, getCharacter, getCharacter, getDouble, getDouble, getFloat, getFloat, getInteger, getInteger, getLong, getLong, getShort, getShort, use, useBoolean, useBoolean, useByte, useByte, useDouble, useDouble, useFloat, useFloat, useInteger, useInteger, useLong, useLong, useShort, useShort

Methods inherited from interface org.refcodes.structure.PropertiesAccessorMixin.PropertiesMutatorMixin

put, put, putBoolean, putBoolean, putByte, putByte, putDouble, putDouble, putFloat, putFloat, putInteger, putInteger, putLong, putLong, putShort, putShort

Method Detail

withPut

default CanonicalMap.CanonicalMapBuilder withPut(String aKey,
                                                 String aValue)

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

Specified by:

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

Specified by:

withPut in interface PathMap.PathMapBuilder<String>

Specified by:

withPut in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

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 CanonicalMap.CanonicalMapBuilder withPut(Relation<String,String> aProperty)

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

Specified by:

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

Specified by:

withPut in interface PathMap.PathMapBuilder<String>

Parameters:

aProperty - the property to be put.

Returns:

The implementing instance as of the builder pattern.

withPutInteger

default CanonicalMap.CanonicalMapBuilder withPutInteger(String aKey,
                                                        Integer aValue)

Sets the Integer value for the property referred to by the key. As property keys and values are of type String, the Integer value is converted accordingly.

Specified by:

withPutInteger in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Integer representation for the String value.

Returns:

This instance for further builder method calls.

withPutShort

default CanonicalMap.CanonicalMapBuilder withPutShort(String aKey,
                                                      Short aValue)

Sets the Short value for the property referred to by the key. As property keys and values are of type String, the Short value is converted accordingly.

Specified by:

withPutShort in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Short representation for the String value.

Returns:

This instance for further builder method calls.

withPutByte

default CanonicalMap.CanonicalMapBuilder withPutByte(String aKey,
                                                     Byte aValue)

Sets the Byte value for the property referred to by the key. As property keys and values are of type String, the Byte value is converted accordingly.

Specified by:

withPutByte in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Byte representation for the String value.

Returns:

This instance for further builder method calls.

withPutDouble

default CanonicalMap.CanonicalMapBuilder withPutDouble(String aKey,
                                                       Double aValue)

Sets the Double value for the property referred to by the key. As property keys and values are of type String, the Double value is converted accordingly.

Specified by:

withPutDouble in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Double representation for the String value.

Returns:

This instance for further builder method calls.

withPutFloat

default CanonicalMap.CanonicalMapBuilder withPutFloat(String aKey,
                                                      Float aValue)

Sets the Float value for the property referred to by the key. As property keys and values are of type String, the Float value is converted accordingly.

Specified by:

withPutFloat in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Float representation for the String value.

Returns:

This instance for further builder method calls.

withPutBoolean

default CanonicalMap.CanonicalMapBuilder withPutBoolean(String aKey,
                                                        Boolean aValue)

Sets the Boolean value for the property referred to by the key. As property keys and values are of type String, the Boolean value is converted accordingly.

Specified by:

withPutBoolean in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Boolean representation for the String value.

Returns:

This instance for further builder method calls.

withPutLong

default CanonicalMap.CanonicalMapBuilder withPutLong(String aKey,
                                                     Long aValue)

Sets the Long value for the property referred to by the key. As property keys and values are of type String, the Long value is converted accordingly.

Specified by:

withPutLong in interface PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Long representation for the String value.

Returns:

This instance for further builder method calls.

withInsert

default CanonicalMap.CanonicalMapBuilder withInsert(Object aObj)

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

Specified by:

withInsert in interface PathMap.PathMapBuilder<String>

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 CanonicalMap.CanonicalMapBuilder withInsertFrom(Object aFrom,
                                                        String aFromPath)

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

Specified by:

withInsertFrom in interface PathMap.PathMapBuilder<String>

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 CanonicalMap.CanonicalMapBuilder withInsertTo(String aToPath,
                                                      Object aFrom)

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

Specified by:

withInsertTo in interface PathMap.PathMapBuilder<String>

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 CanonicalMap.CanonicalMapBuilder withInsert(String aToPath,
                                                    Object aFrom,
                                                    String aFromPath)

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

Specified by:

withInsert in interface PathMap.PathMapBuilder<String>

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)

withRemoveFrom

default CanonicalMap.CanonicalMapBuilder withRemoveFrom(String aPath)

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

Specified by:

withRemoveFrom in interface PathMap.PathMapBuilder<String>

Parameters:

aPath - The path from where to remove all properties.

Returns:

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

withInsert

default CanonicalMap.CanonicalMapBuilder withInsert(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.

Returns:

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

See Also:

PathMap.MutablePathMap.insert(Object)

withInsertFrom

default CanonicalMap.CanonicalMapBuilder withInsertFrom(CanonicalMap aFrom,
                                                        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.

Returns:

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

See Also:

PathMap.MutablePathMap.insertFrom(Object, String)

withInsertTo

default CanonicalMap.CanonicalMapBuilder withInsertTo(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.

Returns:

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

See Also:

PathMap.MutablePathMap.insertTo(String, Object)

withInsert

default CanonicalMap.CanonicalMapBuilder withInsert(String aToPath,
                                                    CanonicalMap 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 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.

Returns:

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

See Also:

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