Module org.refcodes.hal

Package org.refcodes.hal

Class HalMap

java.lang.Object

org.refcodes.struct.PathMapBuilderImpl<String>

org.refcodes.struct.CanonicalMapBuilderImpl

org.refcodes.hal.HalMap

All Implemented Interfaces:

Serializable, Map<String,String>, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.Clearable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.TypeAccessor<String>, org.refcodes.struct.CanonicalMap, org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.Dictionary<String,String>, org.refcodes.struct.Dictionary.MutableDictionary<String,String>, org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.struct.PathMap.PathMapBuilder<String>>, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.struct.Keys.MutableKeys<String,String>, org.refcodes.struct.Keys.MutableValues<String,String>, org.refcodes.struct.PathMap<String>, org.refcodes.struct.PathMap.MutablePathMap<String>, org.refcodes.struct.PathMap.PathMapBuilder<String>

Direct Known Subclasses:

HalData, HalStruct

public class HalMap
extends org.refcodes.struct.CanonicalMapBuilderImpl

Common type for HAL related data. The HalMap extends the CanonicalMapBuilderImpl class. The path delimiter as of PathMapBuilderImpl.getDelimiter() is set to be the Delimiter.PATH character.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

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

org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.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.struct.Dictionary

org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,V extends Object>

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

org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<K extends Object,V extends Object,B extends org.refcodes.struct.Dictionary.MutableDictionary.DictionaryBuilder<K,V,B>>

Nested classes/interfaces inherited from interface org.refcodes.mixin.EmptyAccessor

org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

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

org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HAL_ALPS
static final String	HAL_DESCRIPTOR
static final String	HAL_DESCRIPTORS
static final String	HAL_DOC
static final String	HAL_EMBEDDED
static final String	HAL_ENUM
static final String	HAL_FORMAT
static final String	HAL_HREF
static final String	HAL_LINKS
static final String	HAL_NAME
static final String[]	HAL_PATH_SELF_HREF
static final String	HAL_PROFILE
static final String	HAL_PROPERTIES
static final String	HAL_READ_ONLY
static final String	HAL_REF
static final String	HAL_RELATION
static final String	HAL_SELF
static final String	HAL_TEMPLATED
static final String	HAL_TITLE
static final String	HAL_TYPE
static final String	HAL_VALUE
static final String	META_DATA_ARRAY
static final String	META_DATA_ENUM
static final String	META_DATA_FORMAT
static final String	META_DATA_HREF
static final String	META_DATA_READ_ONLY
static final String	META_DATA_SELF
static final String	META_DATA_TYPE
static final String	META_DATA_VALUE
static final String	ROOT_PATH

Fields inherited from class org.refcodes.struct.PathMapBuilderImpl

_backingMap

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Constructor Summary

Constructors

Constructor	Description
HalMap()	Create an empty HalData instance using the public path delimiter "/" (Delimiter.PATH) for the path declarations.
HalMap(Object aObj)	Create a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public path delimiter "/" (Delimiter.PATH) for the path declarations.
HalMap(Object aObj, String aFromPath)	Creates a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public path delimiter "/" (Delimiter.PATH) for the path declarations.
HalMap(String aToPath, Object aObj)	Create a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public path delimiter "/" (Delimiter.PATH) for the path declarations.
HalMap(String aToPath, Object aObj, String aFromPath)	Creates a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public path delimiter "/" (Delimiter.PATH for the path declarations.

Method Summary

Modifier and Type	Method	Description
HalMap	getDirAt(int aIndex)
HalMap	getDirAt(String aPath, int aIndex)
HalMap	putDirAt(int aIndex, Object aDir)
HalMap	putDirAt(int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	putDirAt(Object[] aPathElements, int aIndex, Object aDir)
HalMap	putDirAt(Object[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	putDirAt(Object aPath, int aIndex, Object aDir)
HalMap	putDirAt(Object aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	putDirAt(String[] aPathElements, int aIndex, Object aDir)
HalMap	putDirAt(String[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	putDirAt(String aPath, int aIndex, Object aDir)
HalMap	putDirAt(String aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	putDirAt(Collection<?> aPathElements, int aIndex, Object aDir)
HalMap	putDirAt(Collection<?> aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	query(Object... aQueryElements)
HalMap	query(String aPathQuery)
HalMap	query(String... aQueryElements)
HalMap	query(Collection<?> aQueryElements)
HalMap	query(Pattern aRegExp)
HalMap	queryBetween(Object[] aFromPath, Object[] aPathQuery, Object[] aToPath)
HalMap	queryBetween(Object aFromPath, Object aPathQuery, Object aToPath)
HalMap	queryBetween(String[] aFromPath, String[] aPathQuery, String[] aToPath)
HalMap	queryBetween(String aFromPath, String aPathQuery, String aToPath)
HalMap	queryBetween(String aFromPath, Pattern aRegExp, String aToPath)
HalMap	queryBetween(Collection<?> aFromPath, Collection<?> aPathQuery, Collection<?> aToPath)
HalMap	queryFrom(Object[] aPathQuery, Object[] aFromPath)
HalMap	queryFrom(Object aPathQuery, Object aFromPath)
HalMap	queryFrom(String[] aPathQuery, String[] aFromPath)
HalMap	queryFrom(String aPathQuery, String aFromPath)
HalMap	queryFrom(Collection<?> aPathQuery, Collection<?> aFromPath)
HalMap	queryFrom(Pattern aRegExp, String aFromPath)
HalMap	queryTo(Object[] aPathQuery, String aToPath)
HalMap	queryTo(Object aPathQuery, String aToPath)
HalMap	queryTo(String[] aPathQuery, String aToPath)
HalMap	queryTo(String aPathQuery, String aToPath)
HalMap	queryTo(Collection<?> aPathQuery, String aToPath)
HalMap	queryTo(Pattern aRegExp, String aToPath)
HalMap	removeAll(Object aPathQuery)
HalMap	removeAll(Object... aPathQueryElements)
HalMap	removeAll(String aPathQuery)
HalMap	removeAll(String... aPathQueryElements)
HalMap	removeAll(Collection<?> aPathQueryElements)
HalMap	removeAll(Pattern aRegExp)
HalMap	removeDirAt(int aIndex)
HalMap	removeDirAt(Object[] aPathElements, int aIndex)
HalMap	removeDirAt(Object aPath, int aIndex)
HalMap	removeDirAt(String[] aPathElements, int aIndex)
HalMap	removeDirAt(String aPath, int aIndex)
HalMap	removeFrom(Object aPath)
HalMap	removeFrom(Object... aPathElements)
HalMap	removeFrom(String aPath)
HalMap	removeFrom(String... aPathElements)
HalMap	removePaths(String... aPaths)
HalMap	removePaths(Collection<?> aPaths)
HalMap	retrieveBetween(Object[] aFromPath, Object[] aToPath)
HalMap	retrieveBetween(Object aFromPath, Object aToPath)
HalMap	retrieveBetween(String[] aFromPath, String[] aToPath)
HalMap	retrieveBetween(String aFromPath, String aToPath)
HalMap	retrieveBetween(Collection<?> aFromPath, Collection<?> aToPath)
HalMap	retrieveFrom(Object aParentPath)
HalMap	retrieveFrom(Object... aPathElements)
HalMap	retrieveFrom(String aFromPath)
HalMap	retrieveFrom(String... aPathElements)
HalMap	retrieveFrom(Collection<?> aPathElements)
HalMap	retrieveTo(Object aToPath)
HalMap	retrieveTo(Object... aToPathElements)
HalMap	retrieveTo(String aToPath)
HalMap	retrieveTo(String... aToPathElements)
HalMap	retrieveTo(Collection<?> aToPathElements)
org.refcodes.struct.CanonicalMap.CanonicalMapBuilder	toPayload()	Creates a vanilla plain HalData instance from this HalMap (e.g.
<T> T	toType(Class<T> aType)
<T> T	toType(String aFromPath, Class<T> aType)
HalMap	withInsert(Object aObj)
HalMap	withInsert(org.refcodes.struct.PathMap<String> aFrom)
HalMap	withInsertBetween(Object[] aToPathElements, Object aFrom, Object[] aFromPathElements)
HalMap	withInsertBetween(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Object[] aFromPathElements)
HalMap	withInsertBetween(Object aToPath, Object aFrom, Object aFromPath)
HalMap	withInsertBetween(Object aToPath, org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
HalMap	withInsertBetween(String[] aToPathElements, Object aFrom, String[] aFromPathElements)
HalMap	withInsertBetween(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, String[] aFromPathElements)
HalMap	withInsertBetween(String aToPath, Object aFrom, String aFromPath)
HalMap	withInsertBetween(String aToPath, org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
HalMap	withInsertBetween(Collection<?> aToPathElements, Object aFrom, Collection<?> aFromPathElements)
HalMap	withInsertBetween(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
HalMap	withInsertFrom(Object aFrom, Object aFromPath)
HalMap	withInsertFrom(Object aFrom, Object... aFromPathElements)
HalMap	withInsertFrom(Object aFrom, String aFromPath)
HalMap	withInsertFrom(Object aFrom, String... aFromPathElements)
HalMap	withInsertFrom(Object aFrom, Collection<?> aFromPathElements)
HalMap	withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
HalMap	withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Object... aFromPathElements)
HalMap	withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
HalMap	withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, String... aFromPathElements)
HalMap	withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
HalMap	withInsertTo(Object[] aToPathElements, Object aFrom)
HalMap	withInsertTo(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withInsertTo(Object aToPath, Object aFrom)
HalMap	withInsertTo(Object aToPath, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withInsertTo(String[] aToPathElements, Object aFrom)
HalMap	withInsertTo(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withInsertTo(String aToPath, Object aFrom)
HalMap	withInsertTo(String aToPath, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withInsertTo(Collection<?> aToPathElements, Object aFrom)
HalMap	withInsertTo(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMerge(Object aObj)
HalMap	withMerge(org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMergeBetween(Object[] aToPathElements, Object aFrom, Object[] aFromPathElements)
HalMap	withMergeBetween(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Object[] aFromPathElements)
HalMap	withMergeBetween(Object aToPath, Object aFrom, Object aFromPath)
HalMap	withMergeBetween(Object aToPath, org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
HalMap	withMergeBetween(String[] aToPathElements, Object aFrom, String[] aFromPathElements)
HalMap	withMergeBetween(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, String[] aFromPathElements)
HalMap	withMergeBetween(String aToPath, Object aFrom, String aFromPath)
HalMap	withMergeBetween(String aToPath, org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
HalMap	withMergeBetween(Collection<?> aToPathElements, Object aFrom, Collection<?> aFromPathElements)
HalMap	withMergeBetween(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
HalMap	withMergeFrom(Object aFrom, Object aFromPath)
HalMap	withMergeFrom(Object aFrom, Object... aFromPathElements)
HalMap	withMergeFrom(Object aFrom, String aFromPath)
HalMap	withMergeFrom(Object aFrom, String... aFromPathElements)
HalMap	withMergeFrom(Object aFrom, Collection<?> aFromPathElements)
HalMap	withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
HalMap	withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Object... aFromPathElements)
HalMap	withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
HalMap	withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, String... aFromPathElements)
HalMap	withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
HalMap	withMergeTo(Object[] aToPathElements, Object aFrom)
HalMap	withMergeTo(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMergeTo(Object aToPath, Object aFrom)
HalMap	withMergeTo(Object aToPath, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMergeTo(String[] aToPathElements, Object aFrom)
HalMap	withMergeTo(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMergeTo(String aToPath, Object aFrom)
HalMap	withMergeTo(String aToPath, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withMergeTo(Collection<?> aToPathElements, Object aFrom)
HalMap	withMergeTo(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
HalMap	withPut(Object[] aPathElements, String aValue)
HalMap	withPut(String[] aKey, String aValue)
HalMap	withPut(String aKey, String aValue)
HalMap	withPut(Collection<?> aPathElements, String aValue)
HalMap	withPut(org.refcodes.struct.Property aProperty)
HalMap	withPut(org.refcodes.struct.Relation<String,String> aProperty)
HalMap	withPutBoolean(Object[] aPathElements, Boolean aValue)
HalMap	withPutBoolean(Object aKey, Boolean aValue)
HalMap	withPutBoolean(String[] aPathElements, Boolean aValue)
HalMap	withPutBoolean(String aKey, Boolean aValue)
HalMap	withPutBoolean(Collection<?> aPathElements, Boolean aValue)
HalMap	withPutByte(Object[] aPathElements, Byte aValue)
HalMap	withPutByte(Object aKey, Byte aValue)
HalMap	withPutByte(String[] aPathElements, Byte aValue)
HalMap	withPutByte(String aKey, Byte aValue)
HalMap	withPutByte(Collection<?> aPathElements, Byte aValue)
HalMap	withPutChar(Object[] aPathElements, Character aValue)
HalMap	withPutChar(Object aKey, Character aValue)
HalMap	withPutChar(String[] aPathElements, Character aValue)
HalMap	withPutChar(String aKey, Character aValue)
HalMap	withPutChar(Collection<?> aPathElements, Character aValue)
<C> HalMap	withPutClass(Object[] aPathElements, Class<C> aValue)
<C> HalMap	withPutClass(Object aKey, Class<C> aValue)
<C> HalMap	withPutClass(String[] aPathElements, Class<C> aValue)
<C> HalMap	withPutClass(String aKey, Class<C> aValue)
<C> HalMap	withPutClass(Collection<?> aPathElements, Class<C> aValue)
HalMap	withPutDirAt(int aIndex, Object aDir)
HalMap	withPutDirAt(int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDirAt(Object[] aPathElements, int aIndex, Object aDir)
HalMap	withPutDirAt(Object[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDirAt(Object aPath, int aIndex, Object aDir)
HalMap	withPutDirAt(Object aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDirAt(String[] aPathElements, int aIndex, Object aDir)
HalMap	withPutDirAt(String[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDirAt(String aPath, int aIndex, Object aDir)
HalMap	withPutDirAt(String aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDirAt(Collection<?> aPathElements, int aIndex, Object aDir)
HalMap	withPutDirAt(Collection<?> aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir)
HalMap	withPutDouble(Object[] aPathElements, Double aValue)
HalMap	withPutDouble(Object aKey, Double aValue)
HalMap	withPutDouble(String[] aPathElements, Double aValue)
HalMap	withPutDouble(String aKey, Double aValue)
HalMap	withPutDouble(Collection<?> aPathElements, Double aValue)
<E extends Enum<E>> HalMap	withPutEnum(Object[] aPathElements, E aValue)
<E extends Enum<E>> HalMap	withPutEnum(Object aKey, E aValue)
<E extends Enum<E>> HalMap	withPutEnum(String[] aPathElements, E aValue)
<E extends Enum<E>> HalMap	withPutEnum(String aKey, E aValue)
<E extends Enum<E>> HalMap	withPutEnum(Collection<?> aPathElements, E aValue)
HalMap	withPutFloat(Object[] aPathElements, Float aValue)
HalMap	withPutFloat(Object aKey, Float aValue)
HalMap	withPutFloat(String[] aPathElements, Float aValue)
HalMap	withPutFloat(String aKey, Float aValue)
HalMap	withPutFloat(Collection<?> aPathElements, Float aValue)
HalMap	withPutInt(Object[] aPathElements, Integer aValue)
HalMap	withPutInt(Object aKey, Integer aValue)
HalMap	withPutInt(String[] aPathElements, Integer aValue)
HalMap	withPutInt(String aKey, Integer aValue)
HalMap	withPutInt(Collection<?> aPathElements, Integer aValue)
HalMap	withPutLong(Object[] aPathElements, Long aValue)
HalMap	withPutLong(Object aKey, Long aValue)
HalMap	withPutLong(String[] aPathElements, Long aValue)
HalMap	withPutLong(String aKey, Long aValue)
HalMap	withPutLong(Collection<?> aPathElements, Long aValue)
HalMap	withPutShort(Object[] aPathElements, Short aValue)
HalMap	withPutShort(Object aKey, Short aValue)
HalMap	withPutShort(String[] aPathElements, Short aValue)
HalMap	withPutShort(String aKey, Short aValue)
HalMap	withPutShort(Collection<?> aPathElements, Short aValue)
HalMap	withPutString(Object[] aPathElements, String aValue)
HalMap	withPutString(Object aKey, String aValue)
HalMap	withPutString(String[] aPathElements, String aValue)
HalMap	withPutString(String aKey, String aValue)
HalMap	withPutString(Collection<?> aPathElements, String aValue)
HalMap	withRemoveFrom(Object aPath)
HalMap	withRemoveFrom(Object... aPathElements)
HalMap	withRemoveFrom(String aPath)
HalMap	withRemoveFrom(String... aPathElements)
HalMap	withRemoveFrom(Collection<?> aPathElements)
HalMap	withRemovePaths(String... aPathElements)

Methods inherited from class org.refcodes.struct.CanonicalMapBuilderImpl

fromInstance, fromObject, toInstance

Methods inherited from class org.refcodes.struct.PathMapBuilderImpl

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, createBackingMap, entrySet, equals, forEach, fromValue, fromValue, get, getAnnotator, getDelimiter, getOrDefault, getType, hashCode, insert, insertBetween, insertFrom, insertTo, isEmpty, keySet, merge, merge, mergeBetween, mergeFrom, mergeTo, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toDataStructure, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.AnnotatorAccessor

getAnnotator

Methods inherited from interface org.refcodes.struct.CanonicalMap

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, toMap, toProperties

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

containsValue, insert, insertBetween, insertFrom, insertTo, put, put, put, put, put, putAll, putAll, putAll, removeFrom, toDump

Methods inherited from interface org.refcodes.mixin.Clearable

clear

Methods inherited from interface org.refcodes.struct.Containable

size

Methods inherited from interface org.refcodes.mixin.DelimiterAccessor

getDelimiter

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

Methods inherited from interface org.refcodes.struct.InterOperableMap

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface org.refcodes.struct.InterOperableMap.MutableInterOperableMap

containsValue, insert, insertBetween, insertFrom, insertTo, putBoolean, putBoolean, putBoolean, putBoolean, putBoolean, putByte, putByte, putByte, putByte, putByte, putChar, putChar, putChar, putChar, putChar, putClass, putClass, putClass, putClass, putClass, putDouble, putDouble, putDouble, putDouble, putDouble, putEnum, putEnum, putEnum, putEnum, putEnum, putFloat, putFloat, putFloat, putFloat, putFloat, putInt, putInt, putInt, putInt, putInt, putLong, putLong, putLong, putLong, putLong, putShort, putShort, putShort, putShort, putShort, putString, putString, putString, putString, putString

Methods inherited from interface org.refcodes.struct.Keys

containsKey, get, getOr, keySet, use, values

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

put

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.refcodes.struct.PathMap

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPrintable, toPropertyPath, toType, toType, toType, toType, toType, toType

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

add, add, add, add, add, add, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendDirTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, appendValueTo, delete, delete, delete, delete, delete, fromType, fromType, fromType, fromType, fromType, fromType, fromType, fromType, insert, insert, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertBetween, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertFrom, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, insertTo, merge, merge, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeBetween, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, mergeTo, put, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putArray, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, putValueAt, remove, remove, remove, removeValueAt, removeValueAt, removeValueAt, removeValueAt, removeValueAt, toSourceCode, toSourceCode

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Field Details

HAL_ALPS

public static final String HAL_ALPS

See Also:

• Constant Field Values

HAL_DESCRIPTOR

public static final String HAL_DESCRIPTOR

See Also:

• Constant Field Values

HAL_DESCRIPTORS

public static final String HAL_DESCRIPTORS

See Also:

• Constant Field Values

HAL_DOC

public static final String HAL_DOC

See Also:

• Constant Field Values

HAL_EMBEDDED

public static final String HAL_EMBEDDED

See Also:

• Constant Field Values

HAL_ENUM

public static final String HAL_ENUM

See Also:

• Constant Field Values

HAL_FORMAT

public static final String HAL_FORMAT

See Also:

• Constant Field Values

HAL_HREF

public static final String HAL_HREF

See Also:

• Constant Field Values

HAL_LINKS

public static final String HAL_LINKS

See Also:

• Constant Field Values

HAL_NAME

public static final String HAL_NAME

See Also:

• Constant Field Values

HAL_SELF

public static final String HAL_SELF

See Also:

• Constant Field Values

HAL_PATH_SELF_HREF

public static final String[] HAL_PATH_SELF_HREF

HAL_PROFILE

public static final String HAL_PROFILE

See Also:

• Constant Field Values

HAL_PROPERTIES

public static final String HAL_PROPERTIES

See Also:

• Constant Field Values

HAL_READ_ONLY

public static final String HAL_READ_ONLY

See Also:

• Constant Field Values

HAL_REF

public static final String HAL_REF

See Also:

• Constant Field Values

HAL_RELATION

public static final String HAL_RELATION

See Also:

• Constant Field Values

HAL_TEMPLATED

public static final String HAL_TEMPLATED

See Also:

• Constant Field Values

HAL_TITLE

public static final String HAL_TITLE

See Also:

• Constant Field Values

HAL_TYPE

public static final String HAL_TYPE

See Also:

• Constant Field Values

HAL_VALUE

public static final String HAL_VALUE

See Also:

• Constant Field Values

META_DATA_ARRAY

public static final String META_DATA_ARRAY

META_DATA_ENUM

public static final String META_DATA_ENUM

META_DATA_FORMAT

public static final String META_DATA_FORMAT

META_DATA_HREF

public static final String META_DATA_HREF

META_DATA_READ_ONLY

public static final String META_DATA_READ_ONLY

META_DATA_SELF

public static final String META_DATA_SELF

META_DATA_TYPE

public static final String META_DATA_TYPE

META_DATA_VALUE

public static final String META_DATA_VALUE

ROOT_PATH

public static final String ROOT_PATH

See Also:

• Constant Field Values

Constructor Details

HalMap

public HalMap()

Create an empty HalData instance using the public path delimiter "/" (Delimiter.PATH) for the path declarations.

HalMap

public HalMap(Object aObj)

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

Parameters:

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

HalMap

public HalMap(Object aObj,
 String aFromPath)

Creates a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public 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.

HalMap

public HalMap(String aToPath,
 Object aObj)

Create a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public 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.

HalMap

public HalMap(String aToPath,
 Object aObj,
 String aFromPath)

Creates a HalData instance containing the elements as of PathMap.MutablePathMap.insert(Object) using the public 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.

Method Details

getDirAt

public HalMap getDirAt(int aIndex)

getDirAt

public HalMap getDirAt(String aPath,
 int aIndex)

putDirAt

public HalMap putDirAt(Collection<?> aPathElements,
 int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(Collection<?> aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(Object aPath,
 int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(Object aPath,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(Object[] aPathElements,
 int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(Object[] aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(String aPath,
 int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(String aPath,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(String[] aPathElements,
 int aIndex,
 Object aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

putDirAt

public HalMap putDirAt(String[] aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                throws IllegalArgumentException

Throws:

IllegalArgumentException

query

public HalMap query(Collection<?> aQueryElements)

query

public HalMap query(Object... aQueryElements)

query

public HalMap query(Pattern aRegExp)

query

public HalMap query(String aPathQuery)

query

public HalMap query(String... aQueryElements)

queryBetween

public HalMap queryBetween(Collection<?> aFromPath,
 Collection<?> aPathQuery,
 Collection<?> aToPath)

queryBetween

public HalMap queryBetween(Object aFromPath,
 Object aPathQuery,
 Object aToPath)

queryBetween

public HalMap queryBetween(Object[] aFromPath,
 Object[] aPathQuery,
 Object[] aToPath)

queryBetween

public HalMap queryBetween(String aFromPath,
 Pattern aRegExp,
 String aToPath)

queryBetween

public HalMap queryBetween(String aFromPath,
 String aPathQuery,
 String aToPath)

queryBetween

public HalMap queryBetween(String[] aFromPath,
 String[] aPathQuery,
 String[] aToPath)

queryFrom

public HalMap queryFrom(Collection<?> aPathQuery,
 Collection<?> aFromPath)

queryFrom

public HalMap queryFrom(Object aPathQuery,
 Object aFromPath)

queryFrom

public HalMap queryFrom(Object[] aPathQuery,
 Object[] aFromPath)

queryFrom

public HalMap queryFrom(Pattern aRegExp,
 String aFromPath)

queryFrom

public HalMap queryFrom(String aPathQuery,
 String aFromPath)

queryFrom

public HalMap queryFrom(String[] aPathQuery,
 String[] aFromPath)

queryTo

public HalMap queryTo(Collection<?> aPathQuery,
 String aToPath)

queryTo

public HalMap queryTo(Object aPathQuery,
 String aToPath)

queryTo

public HalMap queryTo(Object[] aPathQuery,
 String aToPath)

queryTo

public HalMap queryTo(Pattern aRegExp,
 String aToPath)

queryTo

public HalMap queryTo(String aPathQuery,
 String aToPath)

queryTo

public HalMap queryTo(String[] aPathQuery,
 String aToPath)

removeAll

public HalMap removeAll(Collection<?> aPathQueryElements)

removeAll

public HalMap removeAll(Object... aPathQueryElements)

removeAll

public HalMap removeAll(Object aPathQuery)

removeAll

public HalMap removeAll(Pattern aRegExp)

removeAll

public HalMap removeAll(String... aPathQueryElements)

removeAll

public HalMap removeAll(String aPathQuery)

removeDirAt

public HalMap removeDirAt(int aIndex)

removeDirAt

public HalMap removeDirAt(Object aPath,
 int aIndex)

removeDirAt

public HalMap removeDirAt(Object[] aPathElements,
 int aIndex)

removeDirAt

public HalMap removeDirAt(String aPath,
 int aIndex)

removeDirAt

public HalMap removeDirAt(String[] aPathElements,
 int aIndex)

removeFrom

public HalMap removeFrom(Object... aPathElements)

removeFrom

public HalMap removeFrom(Object aPath)

removeFrom

public HalMap removeFrom(String aPath)

removeFrom

public HalMap removeFrom(String... aPathElements)

removePaths

public HalMap removePaths(Collection<?> aPaths)

removePaths

public HalMap removePaths(String... aPaths)

retrieveBetween

public HalMap retrieveBetween(Collection<?> aFromPath,
 Collection<?> aToPath)

retrieveBetween

public HalMap retrieveBetween(Object aFromPath,
 Object aToPath)

retrieveBetween

public HalMap retrieveBetween(Object[] aFromPath,
 Object[] aToPath)

retrieveBetween

public HalMap retrieveBetween(String aFromPath,
 String aToPath)

retrieveBetween

public HalMap retrieveBetween(String[] aFromPath,
 String[] aToPath)

retrieveFrom

public HalMap retrieveFrom(Collection<?> aPathElements)

retrieveFrom

public HalMap retrieveFrom(Object aParentPath)

retrieveFrom

public HalMap retrieveFrom(Object... aPathElements)

retrieveFrom

public HalMap retrieveFrom(String aFromPath)

Specified by:

retrieveFrom in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveFrom in interface org.refcodes.struct.PathMap<String>

Overrides:

retrieveFrom in class org.refcodes.struct.CanonicalMapBuilderImpl

retrieveFrom

public HalMap retrieveFrom(String... aPathElements)

retrieveTo

public HalMap retrieveTo(Collection<?> aToPathElements)

retrieveTo

public HalMap retrieveTo(Object aToPath)

retrieveTo

public HalMap retrieveTo(Object... aToPathElements)

retrieveTo

public HalMap retrieveTo(String aToPath)

Specified by:

retrieveTo in interface org.refcodes.struct.CanonicalMap

Specified by:

retrieveTo in interface org.refcodes.struct.PathMap<String>

Overrides:

retrieveTo in class org.refcodes.struct.CanonicalMapBuilderImpl

retrieveTo

public HalMap retrieveTo(String... aToPathElements)

toPayload

public org.refcodes.struct.CanonicalMap.CanonicalMapBuilder toPayload()

Creates a vanilla plain HalData instance from this HalMap (e.g. HalData or HalStruct) excluding all Meta-Data and only including the actual payload.

Returns:

The accordingly HalData instance.

toType

public <T> T toType(Class<T> aType)

toType

public <T> T toType(String aFromPath,
 Class<T> aType)

Specified by:

toType in interface org.refcodes.struct.PathMap<String>

Overrides:

toType in class org.refcodes.struct.PathMapBuilderImpl<String>

withInsert

public HalMap withInsert(Object aObj)

withInsert

public HalMap withInsert(org.refcodes.struct.PathMap<String> aFrom)

withInsertBetween

public HalMap withInsertBetween(Collection<?> aToPathElements,
 Object aFrom,
 Collection<?> aFromPathElements)

withInsertBetween

public HalMap withInsertBetween(Collection<?> aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 Collection<?> aFromPathElements)

withInsertBetween

public HalMap withInsertBetween(Object aToPath,
 Object aFrom,
 Object aFromPath)

withInsertBetween

public HalMap withInsertBetween(Object aToPath,
 org.refcodes.struct.PathMap<String> aFrom,
 Object aFromPath)

withInsertBetween

public HalMap withInsertBetween(Object[] aToPathElements,
 Object aFrom,
 Object[] aFromPathElements)

withInsertBetween

public HalMap withInsertBetween(Object[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 Object[] aFromPathElements)

withInsertBetween

public HalMap withInsertBetween(String aToPath,
 Object aFrom,
 String aFromPath)

withInsertBetween

public HalMap withInsertBetween(String aToPath,
 org.refcodes.struct.PathMap<String> aFrom,
 String aFromPath)

withInsertBetween

public HalMap withInsertBetween(String[] aToPathElements,
 Object aFrom,
 String[] aFromPathElements)

withInsertBetween

public HalMap withInsertBetween(String[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 String[] aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(Object aFrom,
 Collection<?> aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(Object aFrom,
 Object aFromPath)

withInsertFrom

public HalMap withInsertFrom(Object aFrom,
 Object... aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(Object aFrom,
 String aFromPath)

withInsertFrom

public HalMap withInsertFrom(Object aFrom,
 String... aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(org.refcodes.struct.PathMap<String> aFrom,
 Collection<?> aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(org.refcodes.struct.PathMap<String> aFrom,
 Object aFromPath)

withInsertFrom

public HalMap withInsertFrom(org.refcodes.struct.PathMap<String> aFrom,
 Object... aFromPathElements)

withInsertFrom

public HalMap withInsertFrom(org.refcodes.struct.PathMap<String> aFrom,
 String aFromPath)

withInsertFrom

public HalMap withInsertFrom(org.refcodes.struct.PathMap<String> aFrom,
 String... aFromPathElements)

withInsertTo

public HalMap withInsertTo(Collection<?> aToPathElements,
 Object aFrom)

withInsertTo

public HalMap withInsertTo(Collection<?> aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withInsertTo

public HalMap withInsertTo(Object aToPath,
 Object aFrom)

withInsertTo

public HalMap withInsertTo(Object aToPath,
 org.refcodes.struct.PathMap<String> aFrom)

withInsertTo

public HalMap withInsertTo(Object[] aToPathElements,
 Object aFrom)

withInsertTo

public HalMap withInsertTo(Object[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withInsertTo

public HalMap withInsertTo(String aToPath,
 Object aFrom)

withInsertTo

public HalMap withInsertTo(String aToPath,
 org.refcodes.struct.PathMap<String> aFrom)

withInsertTo

public HalMap withInsertTo(String[] aToPathElements,
 Object aFrom)

withInsertTo

public HalMap withInsertTo(String[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withMerge

public HalMap withMerge(Object aObj)

withMerge

public HalMap withMerge(org.refcodes.struct.PathMap<String> aFrom)

withMergeBetween

public HalMap withMergeBetween(Collection<?> aToPathElements,
 Object aFrom,
 Collection<?> aFromPathElements)

withMergeBetween

public HalMap withMergeBetween(Collection<?> aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 Collection<?> aFromPathElements)

withMergeBetween

public HalMap withMergeBetween(Object aToPath,
 Object aFrom,
 Object aFromPath)

withMergeBetween

public HalMap withMergeBetween(Object aToPath,
 org.refcodes.struct.PathMap<String> aFrom,
 Object aFromPath)

withMergeBetween

public HalMap withMergeBetween(Object[] aToPathElements,
 Object aFrom,
 Object[] aFromPathElements)

withMergeBetween

public HalMap withMergeBetween(Object[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 Object[] aFromPathElements)

withMergeBetween

public HalMap withMergeBetween(String aToPath,
 Object aFrom,
 String aFromPath)

withMergeBetween

public HalMap withMergeBetween(String aToPath,
 org.refcodes.struct.PathMap<String> aFrom,
 String aFromPath)

withMergeBetween

public HalMap withMergeBetween(String[] aToPathElements,
 Object aFrom,
 String[] aFromPathElements)

withMergeBetween

public HalMap withMergeBetween(String[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom,
 String[] aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(Object aFrom,
 Collection<?> aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(Object aFrom,
 Object aFromPath)

withMergeFrom

public HalMap withMergeFrom(Object aFrom,
 Object... aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(Object aFrom,
 String aFromPath)

withMergeFrom

public HalMap withMergeFrom(Object aFrom,
 String... aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(org.refcodes.struct.PathMap<String> aFrom,
 Collection<?> aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(org.refcodes.struct.PathMap<String> aFrom,
 Object aFromPath)

withMergeFrom

public HalMap withMergeFrom(org.refcodes.struct.PathMap<String> aFrom,
 Object... aFromPathElements)

withMergeFrom

public HalMap withMergeFrom(org.refcodes.struct.PathMap<String> aFrom,
 String aFromPath)

withMergeFrom

public HalMap withMergeFrom(org.refcodes.struct.PathMap<String> aFrom,
 String... aFromPathElements)

withMergeTo

public HalMap withMergeTo(Collection<?> aToPathElements,
 Object aFrom)

withMergeTo

public HalMap withMergeTo(Collection<?> aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withMergeTo

public HalMap withMergeTo(Object aToPath,
 Object aFrom)

withMergeTo

public HalMap withMergeTo(Object aToPath,
 org.refcodes.struct.PathMap<String> aFrom)

withMergeTo

public HalMap withMergeTo(Object[] aToPathElements,
 Object aFrom)

withMergeTo

public HalMap withMergeTo(Object[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withMergeTo

public HalMap withMergeTo(String aToPath,
 Object aFrom)

withMergeTo

public HalMap withMergeTo(String aToPath,
 org.refcodes.struct.PathMap<String> aFrom)

withMergeTo

public HalMap withMergeTo(String[] aToPathElements,
 Object aFrom)

withMergeTo

public HalMap withMergeTo(String[] aToPathElements,
 org.refcodes.struct.PathMap<String> aFrom)

withPut

public HalMap withPut(Collection<?> aPathElements,
 String aValue)

withPut

public HalMap withPut(Object[] aPathElements,
 String aValue)
               throws NumberFormatException

Throws:

NumberFormatException

withPut

public HalMap withPut(org.refcodes.struct.Property aProperty)

withPut

public HalMap withPut(org.refcodes.struct.Relation<String,String> aProperty)

withPut

public HalMap withPut(String aKey,
 String aValue)

Specified by:

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

Specified by:

withPut in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>

Overrides:

withPut in class org.refcodes.struct.CanonicalMapBuilderImpl

withPut

public HalMap withPut(String[] aKey,
 String aValue)

withPutBoolean

public HalMap withPutBoolean(Collection<?> aPathElements,
 Boolean aValue)

withPutBoolean

public HalMap withPutBoolean(Object aKey,
 Boolean aValue)

withPutBoolean

public HalMap withPutBoolean(Object[] aPathElements,
 Boolean aValue)

withPutBoolean

public HalMap withPutBoolean(String aKey,
 Boolean aValue)

withPutBoolean

public HalMap withPutBoolean(String[] aPathElements,
 Boolean aValue)

withPutByte

public HalMap withPutByte(Collection<?> aPathElements,
 Byte aValue)

withPutByte

public HalMap withPutByte(Object aKey,
 Byte aValue)

withPutByte

public HalMap withPutByte(Object[] aPathElements,
 Byte aValue)

withPutByte

public HalMap withPutByte(String aKey,
 Byte aValue)

withPutByte

public HalMap withPutByte(String[] aPathElements,
 Byte aValue)

withPutChar

public HalMap withPutChar(Collection<?> aPathElements,
 Character aValue)

withPutChar

public HalMap withPutChar(Object aKey,
 Character aValue)

withPutChar

public HalMap withPutChar(Object[] aPathElements,
 Character aValue)

withPutChar

public HalMap withPutChar(String aKey,
 Character aValue)

withPutChar

public HalMap withPutChar(String[] aPathElements,
 Character aValue)

withPutClass

public <C> HalMap withPutClass(Collection<?> aPathElements,
 Class<C> aValue)

withPutClass

public <C> HalMap withPutClass(Object aKey,
 Class<C> aValue)

withPutClass

public <C> HalMap withPutClass(Object[] aPathElements,
 Class<C> aValue)

withPutClass

public <C> HalMap withPutClass(String aKey,
 Class<C> aValue)

withPutClass

public <C> HalMap withPutClass(String[] aPathElements,
 Class<C> aValue)

withPutDirAt

public HalMap withPutDirAt(Collection<?> aPathElements,
 int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(Collection<?> aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(Object aPath,
 int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(Object aPath,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(Object[] aPathElements,
 int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(Object[] aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(String aPath,
 int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(String aPath,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(String[] aPathElements,
 int aIndex,
 Object aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDirAt

public HalMap withPutDirAt(String[] aPathElements,
 int aIndex,
 org.refcodes.struct.PathMap<String> aDir)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

withPutDouble

public HalMap withPutDouble(Collection<?> aPathElements,
 Double aValue)

withPutDouble

public HalMap withPutDouble(Object aKey,
 Double aValue)

withPutDouble

public HalMap withPutDouble(Object[] aPathElements,
 Double aValue)

withPutDouble

public HalMap withPutDouble(String aKey,
 Double aValue)

withPutDouble

public HalMap withPutDouble(String[] aPathElements,
 Double aValue)

withPutEnum

public <E extends Enum<E>> HalMap withPutEnum(Collection<?> aPathElements,
 E aValue)

withPutEnum

public <E extends Enum<E>> HalMap withPutEnum(Object aKey,
 E aValue)

withPutEnum

public <E extends Enum<E>> HalMap withPutEnum(Object[] aPathElements,
 E aValue)

withPutEnum

public <E extends Enum<E>> HalMap withPutEnum(String aKey,
 E aValue)

withPutEnum

public <E extends Enum<E>> HalMap withPutEnum(String[] aPathElements,
 E aValue)

withPutFloat

public HalMap withPutFloat(Collection<?> aPathElements,
 Float aValue)

withPutFloat

public HalMap withPutFloat(Object aKey,
 Float aValue)

withPutFloat

public HalMap withPutFloat(Object[] aPathElements,
 Float aValue)

withPutFloat

public HalMap withPutFloat(String aKey,
 Float aValue)

withPutFloat

public HalMap withPutFloat(String[] aPathElements,
 Float aValue)

withPutInt

public HalMap withPutInt(Collection<?> aPathElements,
 Integer aValue)

withPutInt

public HalMap withPutInt(Object aKey,
 Integer aValue)

withPutInt

public HalMap withPutInt(Object[] aPathElements,
 Integer aValue)

withPutInt

public HalMap withPutInt(String aKey,
 Integer aValue)

withPutInt

public HalMap withPutInt(String[] aPathElements,
 Integer aValue)

withPutLong

public HalMap withPutLong(Collection<?> aPathElements,
 Long aValue)

withPutLong

public HalMap withPutLong(Object aKey,
 Long aValue)

withPutLong

public HalMap withPutLong(Object[] aPathElements,
 Long aValue)

withPutLong

public HalMap withPutLong(String aKey,
 Long aValue)

withPutLong

public HalMap withPutLong(String[] aPathElements,
 Long aValue)

withPutShort

public HalMap withPutShort(Collection<?> aPathElements,
 Short aValue)

withPutShort

public HalMap withPutShort(Object aKey,
 Short aValue)

withPutShort

public HalMap withPutShort(Object[] aPathElements,
 Short aValue)

withPutShort

public HalMap withPutShort(String aKey,
 Short aValue)

withPutShort

public HalMap withPutShort(String[] aPathElements,
 Short aValue)

withPutString

public HalMap withPutString(Collection<?> aPathElements,
 String aValue)

withPutString

public HalMap withPutString(Object aKey,
 String aValue)

withPutString

public HalMap withPutString(Object[] aPathElements,
 String aValue)

withPutString

public HalMap withPutString(String aKey,
 String aValue)

withPutString

public HalMap withPutString(String[] aPathElements,
 String aValue)

withRemoveFrom

public HalMap withRemoveFrom(Collection<?> aPathElements)

withRemoveFrom

public HalMap withRemoveFrom(Object aPath)

withRemoveFrom

public HalMap withRemoveFrom(Object... aPathElements)

withRemoveFrom

public HalMap withRemoveFrom(String aPath)

withRemoveFrom

public HalMap withRemoveFrom(String... aPathElements)

withRemovePaths

public HalMap withRemovePaths(String... aPathElements)