Package org.refcodes.structure
Interface CanonicalMap.CanonicalMapBuilder
-
- All Superinterfaces:
CanonicalMap
,CanonicalMap.MutableCanonicalMap
,Clearable
,Containable
,org.refcodes.mixin.DelimiterAccessor
,Dictionary<java.lang.String,java.lang.String>
,Dictionary.MutableDictionary<java.lang.String,java.lang.String>
,Dictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,PathMap.PathMapBuilder<java.lang.String>>
,org.refcodes.mixin.Dumpable
,Keys<java.lang.String,java.lang.String>
,Keys.MutableKeys<java.lang.String,java.lang.String>
,Keys.MutableValues<java.lang.String,java.lang.String>
,java.util.Map<java.lang.String,java.lang.String>
,PathMap<java.lang.String>
,PathMap.MutablePathMap<java.lang.String>
,PathMap.PathMapBuilder<java.lang.String>
,PropertiesAccessorMixin
,PropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
,PropertiesAccessorMixin.PropertiesMixin
,PropertiesAccessorMixin.PropertiesMutatorMixin
,org.refcodes.mixin.TypeAccessor<java.lang.String>
- All Known Implementing Classes:
CanonicalMapBuilderImpl
- Enclosing interface:
- CanonicalMap
public static interface CanonicalMap.CanonicalMapBuilder extends PathMap.PathMapBuilder<java.lang.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.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.structure.PropertiesAccessorMixin
PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin
-
-
Field Summary
-
Fields inherited from interface org.refcodes.structure.CanonicalMap
DEFAULT_COMMENT
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default CanonicalMap.CanonicalMapBuilder
withInsert(java.lang.Object aObj)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insert(Object)
method.default CanonicalMap.CanonicalMapBuilder
withInsert(java.lang.String aToPath, java.lang.Object aFrom, java.lang.String aFromPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insert(String, Object, String)
method.default CanonicalMap.CanonicalMapBuilder
withInsert(java.lang.String aToPath, CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types.default CanonicalMap.CanonicalMapBuilder
withInsert(CanonicalMap aFrom)
Method to semantically emphasize that we support our own types.default CanonicalMap.CanonicalMapBuilder
withInsertFrom(java.lang.Object aFrom, java.lang.String aFromPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insertFrom(Object, String)
method.default CanonicalMap.CanonicalMapBuilder
withInsertFrom(CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types.default CanonicalMap.CanonicalMapBuilder
withInsertTo(java.lang.String aToPath, java.lang.Object aFrom)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insertTo(String, Object)
method.default CanonicalMap.CanonicalMapBuilder
withInsertTo(java.lang.String aToPath, CanonicalMap aFrom)
Method to semantically emphasize that we support our own types.default CanonicalMap.CanonicalMapBuilder
withPut(java.lang.String aKey, java.lang.String aValue)
Builder method forKeys.MutableValues.put(Object, Object)
.default CanonicalMap.CanonicalMapBuilder
withPut(Relation<java.lang.String,java.lang.String> aProperty)
Builder method forDictionary.MutableDictionary.put(Relation)
.default CanonicalMap.CanonicalMapBuilder
withPutBoolean(java.lang.String aKey, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutByte(java.lang.String aKey, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutDouble(java.lang.String aKey, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutFloat(java.lang.String aKey, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutInteger(java.lang.String aKey, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutLong(java.lang.String aKey, java.lang.Long aValue)
Sets theLong
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withPutShort(java.lang.String aKey, java.lang.Short aValue)
Sets theShort
value for the property referred to by the key.default CanonicalMap.CanonicalMapBuilder
withRemoveFrom(java.lang.String aPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.removeAll( String)
method.-
Methods inherited from interface org.refcodes.structure.CanonicalMap
childrenOf, retrieve, retrieveFrom, retrieveTo, toInstance, toInstance, toType, toType
-
Methods inherited from interface org.refcodes.structure.CanonicalMap.MutableCanonicalMap
containsValue, delete, insert, insert, insertFrom, insertTo, put, putAll, putAll, putAll, toDump, toSourceCode, toSourceCode
-
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.PathMap
directories, directories, entries, entries, fromExternalKey, getArray, getArray, getRootPath, hasParentPath, isArray, isArray, isDirectory, isEntry, isRecord, isRootPath, keySet, paths, paths, records, records, toDataStructure, toDataStructure, toExternalKey, toMap, toMap, toNormalizedPath, toNormalizedPath, toParentPath, toPath
-
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.PathMapBuilder
withInsert, withInsert, withInsertFrom, withInsertTo
-
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.PropertiesBuilderMixin
withPut
-
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(java.lang.String aKey, java.lang.String aValue)
Builder method forKeys.MutableValues.put(Object, Object)
.- Specified by:
withPut
in interfaceDictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,PathMap.PathMapBuilder<java.lang.String>>
- Specified by:
withPut
in interfacePathMap.PathMapBuilder<java.lang.String>
- Specified by:
withPut
in interfacePropertiesAccessorMixin.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<java.lang.String,java.lang.String> aProperty)
Builder method forDictionary.MutableDictionary.put(Relation)
.- Specified by:
withPut
in interfaceDictionary.MutableDictionary.DictionaryBuilder<java.lang.String,java.lang.String,PathMap.PathMapBuilder<java.lang.String>>
- Specified by:
withPut
in interfacePathMap.PathMapBuilder<java.lang.String>
- Parameters:
aProperty
- the property to be put.- Returns:
- The implementing instance as of the builder pattern.
-
withPutInteger
default CanonicalMap.CanonicalMapBuilder withPutInteger(java.lang.String aKey, java.lang.Integer aValue)
Sets theInteger
value for the property referred to by the key. As property keys and values are of typeString
, theInteger
value is converted accordingly.- Specified by:
withPutInteger
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheInteger
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutShort
default CanonicalMap.CanonicalMapBuilder withPutShort(java.lang.String aKey, java.lang.Short aValue)
Sets theShort
value for the property referred to by the key. As property keys and values are of typeString
, theShort
value is converted accordingly.- Specified by:
withPutShort
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheShort
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutByte
default CanonicalMap.CanonicalMapBuilder withPutByte(java.lang.String aKey, java.lang.Byte aValue)
Sets theByte
value for the property referred to by the key. As property keys and values are of typeString
, theByte
value is converted accordingly.- Specified by:
withPutByte
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheByte
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutDouble
default CanonicalMap.CanonicalMapBuilder withPutDouble(java.lang.String aKey, java.lang.Double aValue)
Sets theDouble
value for the property referred to by the key. As property keys and values are of typeString
, theDouble
value is converted accordingly.- Specified by:
withPutDouble
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheDouble
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutFloat
default CanonicalMap.CanonicalMapBuilder withPutFloat(java.lang.String aKey, java.lang.Float aValue)
Sets theFloat
value for the property referred to by the key. As property keys and values are of typeString
, theFloat
value is converted accordingly.- Specified by:
withPutFloat
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheFloat
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutBoolean
default CanonicalMap.CanonicalMapBuilder withPutBoolean(java.lang.String aKey, java.lang.Boolean aValue)
Sets theBoolean
value for the property referred to by the key. As property keys and values are of typeString
, theBoolean
value is converted accordingly.- Specified by:
withPutBoolean
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheBoolean
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withPutLong
default CanonicalMap.CanonicalMapBuilder withPutLong(java.lang.String aKey, java.lang.Long aValue)
Sets theLong
value for the property referred to by the key. As property keys and values are of typeString
, theLong
value is converted accordingly.- Specified by:
withPutLong
in interfacePropertiesAccessorMixin.PropertiesBuilderMixin<CanonicalMap.CanonicalMapBuilder>
- Parameters:
aKey
- The key for which to retrieve the value.aValue
- TheLong
representation for theString
value.- Returns:
- This instance for further builder method calls.
-
withInsert
default CanonicalMap.CanonicalMapBuilder withInsert(java.lang.Object aObj)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insert(Object)
method.- Specified by:
withInsert
in interfacePathMap.PathMapBuilder<java.lang.String>
- Parameters:
aObj
- the obj- Returns:
- This instance as of the Builder-Pattern to apply succeeding operations.
- See Also:
PathMap.MutablePathMap.insert(Object)
-
withInsertFrom
default CanonicalMap.CanonicalMapBuilder withInsertFrom(java.lang.Object aFrom, java.lang.String aFromPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insertFrom(Object, String)
method.- Specified by:
withInsertFrom
in interfacePathMap.PathMapBuilder<java.lang.String>
- Parameters:
aFrom
- the fromaFromPath
- the 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(java.lang.String aToPath, java.lang.Object aFrom)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insertTo(String, Object)
method.- Specified by:
withInsertTo
in interfacePathMap.PathMapBuilder<java.lang.String>
- Parameters:
aToPath
- the to pathaFrom
- the 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(java.lang.String aToPath, java.lang.Object aFrom, java.lang.String aFromPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.insert(String, Object, String)
method.- Specified by:
withInsert
in interfacePathMap.PathMapBuilder<java.lang.String>
- Parameters:
aToPath
- the to pathaFrom
- the fromaFromPath
- the 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(java.lang.String aPath)
Convenience method for providing builder functionality to thePathMap.MutablePathMap.removeAll( String)
method.- Specified by:
withRemoveFrom
in interfacePathMap.PathMapBuilder<java.lang.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 toPathMap.MutablePathMap.insert(Object)
.- Parameters:
aFrom
- TheCanonicalMap
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, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertFrom(Object, String)
.- Parameters:
aFrom
- TheCanonicalMap
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(java.lang.String aToPath, CanonicalMap aFrom)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insertTo(String, Object)
.- Parameters:
aToPath
- The sub-path where to insert the object's introspected values to.aFrom
- TheCanonicalMap
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(java.lang.String aToPath, CanonicalMap aFrom, java.lang.String aFromPath)
Method to semantically emphasize that we support our own types. Actually delegates toPathMap.MutablePathMap.insert(String, Object, String)
.- Parameters:
aToPath
- The sub-path where to insert the object's introspected values to.aFrom
- TheCanonicalMap
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)
-
-