public interface CanonicalMap extends PathMap<String>, PropertiesAccessorMixin
CanonicalMap
is an "intermediate" type adding type and
Data-Structure related functionality to any implementing class.Modifier and Type | Interface and Description |
---|---|
static interface |
CanonicalMap.CanonicalMapBuilder
The Interface CanonicalMapBuilder.
|
static interface |
CanonicalMap.MutableCanonicalMap
The Interface MutableCanonicalMap.
|
PathMap.MutablePathMap<T>, PathMap.PathMapBuilder<T>
Dictionary.MutableDictionary<K,V>
Keys.MutableKeys<K,V>, Keys.MutableValues<K,V>
org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty
org.refcodes.mixin.TypeAccessor.TypeMutator<T>, org.refcodes.mixin.TypeAccessor.TypeProperty<T>
PropertiesAccessorMixin.PropertiesBuilderMixin<T>, PropertiesAccessorMixin.PropertiesMixin, PropertiesAccessorMixin.PropertiesMutatorMixin
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_COMMENT |
Modifier and Type | Method and Description |
---|---|
CanonicalMap |
childrenOf(String aParentPath)
Gets the children elements of the provided parent's path, excluding the
parent's path.
|
default boolean |
containsValue(Object value)
This method is defined for the sake of
Map conformity. |
default CanonicalMap |
retrieve(String aFromPath,
String aToPath)
|
CanonicalMap |
retrieveFrom(String aFromPath)
|
CanonicalMap |
retrieveTo(String aToPath)
|
default <T> void |
toInstance(String aFromPath,
T aInstance)
Updates the instance with this
CanonicalMap 's data. |
default <T> void |
toInstance(T aInstance)
Updates the instance with this
CanonicalMap 's data. |
default <T> T |
toType(Class<T> aType)
Creates an instance of the given type filled with this
CanonicalMap 's data. |
default <T> T |
toType(String aFromPath,
Class<T> aType)
Creates an instance of the given type filled with this
CanonicalMap 's data. |
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
isEmpty, size
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
static final String DEFAULT_COMMENT
default <T> T toType(Class<T> aType)
CanonicalMap
's data.T
- the generic type if which to create an instance.aType
- the type if the instance to be filled with the herein
contained data.default <T> T toType(String aFromPath, Class<T> aType)
CanonicalMap
's data.T
- the generic type if which to create an instance.aFromPath
- The path representing the root from which to take the data
for the instance.aType
- the type if the instance to be filled with the herein
contained data.default <T> void toInstance(T aInstance)
CanonicalMap
's data.
Instances inside the instance may not be updated!T
- the generic type if which to create an instance.aInstance
- The instance to be updated with the herein contained
data.default <T> void toInstance(String aFromPath, T aInstance)
CanonicalMap
's data.
Instances inside the instance may not be updated!T
- the generic type if which to create an instance.aFromPath
- The path representing the root from which to take the data
for the instance.aInstance
- The instance to be updated with the herein contained
data.default boolean containsValue(Object value)
Map
conformity.
Tests whether the provided value has a key assigned.containsValue
in interface Keys<String,String>
value
- The value to test if a key references this value.CanonicalMap retrieveFrom(String aFromPath)
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.retrieveFrom
in interface PathMap<String>
aFromPath
- The path from where to start extracting the paths.PathMap
with the elements below the provided path
which are root elements in the new PathMap
.CanonicalMap retrieveTo(String aToPath)
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.CanonicalMap childrenOf(String aParentPath)
childrenOf
in interface PathMap<String>
aParentPath
- The path from where to retrieve the children.default CanonicalMap retrieve(String aFromPath, String aToPath)
Copyright © 2018. All rights reserved.