Module org.refcodes.hal
Package org.refcodes.hal

Class HalData

java.lang.Object
org.refcodes.struct.PathMapBuilderImpl<String>
org.refcodes.struct.CanonicalMapBuilderImpl
org.refcodes.hal.HalMap
org.refcodes.hal.HalData
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>
public class HalData extends HalMap
/** The HalData interface defines a CanonicalMap.CanonicalMapBuilder https://www.metacodes.proized for working with HAL-Browser data. HalData instances represent the actual payload ("rows") of a HAL-Resource. In comparison, HalStruct instances represent the structure including Meta-Data if a HalData instance. TheHalData extends the CanonicalMapBuilderImpl class. The path delimiter as of PathMapBuilderImpl.getDelimiter() is set to be the Delimiter.PATH character.
See Also:

  • Constructor Details

    • HalData

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

    • HalData

      public HalData(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.

    • HalData

      public HalData(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.

    • HalData

      public HalData(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.

    • HalData

      public HalData(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.

  • Method Details

    • importHref

      public void importHref(String aPath) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Object aPath) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Object... aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(String... aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Collection<?> aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, String aPath) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Object aPath) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Object... aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, String... aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Collection<?> aPathElements) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(String aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Object aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Object[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(String[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(Collection<?> aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Object aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Object[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, String[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, Collection<?> aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPathElements - The path elements representing the path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • importHref

      public void importHref(TraversalMode aMode, String aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Imports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for importing the data.
      aPath - The path to the attribute which is to be imported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(String aPath) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Object aPath) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Object... aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(String... aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Collection<?> aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, String aPath) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Object aPath) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Object... aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, String... aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Collection<?> aPathElements) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(String aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Object aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Object[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(String[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(Collection<?> aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is inserted at the given path.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, String aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Object aPath, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPath - The path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Object[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, String[] aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • exportHref

      public HalData exportHref(TraversalMode aMode, Collection<?> aPathElements, org.refcodes.web.FormFields aQueryFields) throws org.refcodes.web.HttpStatusException
      Exports the data of the HAL-Resource to which value points referenced by the path.
      Parameters:
      aMode - The mode for exporting the data.
      aPathElements - The path elements representing the path to the attribute which is to be exported. The HREF being pointed to is resolved and the referenced data from the HAL-Resource is is returned.
      aQueryFields - The query fields to be appended to the requesting URL.
      Returns:
      The accordingly loaded data.
      Throws:
      org.refcodes.web.HttpStatusException - Thrown in case a HTTP response was of an erroneous status.

    • getId

      public Long getId()
      Extracts the entite's TID from the provided HTTP-Body: We assume a SELF reference and take the last number if the according HREF.
      Returns:
      The TID being extracted.

    • getSelfHref

      public String getSelfHref()
      Extracts the entite's TID from the provided HTTP-Body: We assume a SELF reference and take the last number if the according HREF.
      Returns:
      The TID being extracted.

    • getDirAt

      public HalData getDirAt(int aIndex)
      Specified by:
      getDirAt in interface org.refcodes.struct.CanonicalMap
      Specified by:
      getDirAt in interface org.refcodes.struct.PathMap<String>
      Overrides:
      getDirAt in class HalMap

    • getDirAt

      public HalData getDirAt(String aPath, int aIndex)
      Specified by:
      getDirAt in interface org.refcodes.struct.CanonicalMap
      Specified by:
      getDirAt in interface org.refcodes.struct.PathMap<String>
      Overrides:
      getDirAt in class HalMap

    • putDirAt

      public HalData putDirAt(Collection<?> aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(Collection<?> aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(Object aPath, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(Object aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(Object[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(Object[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(String aPath, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(String aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(String[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • putDirAt

      public HalData putDirAt(String[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      putDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      putDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      putDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • query

      public HalData query(Collection<?> aQueryElements)
      Specified by:
      query in interface org.refcodes.struct.CanonicalMap
      Specified by:
      query in interface org.refcodes.struct.PathMap<String>
      Overrides:
      query in class HalMap

    • query

      public HalData query(Object... aQueryElements)
      Specified by:
      query in interface org.refcodes.struct.CanonicalMap
      Specified by:
      query in interface org.refcodes.struct.PathMap<String>
      Overrides:
      query in class HalMap

    • query

      public HalData query(String aPathQuery)
      Specified by:
      query in interface org.refcodes.struct.CanonicalMap
      Specified by:
      query in interface org.refcodes.struct.PathMap<String>
      Overrides:
      query in class HalMap

    • query

      public HalData query(Pattern aRegExp)
      Specified by:
      query in interface org.refcodes.struct.CanonicalMap
      Specified by:
      query in interface org.refcodes.struct.PathMap<String>
      Overrides:
      query in class HalMap

    • query

      public HalData query(String... aQueryElements)
      Specified by:
      query in interface org.refcodes.struct.CanonicalMap
      Specified by:
      query in interface org.refcodes.struct.PathMap<String>
      Overrides:
      query in class HalMap

    • queryBetween

      public HalData queryBetween(Collection<?> aFromPath, Collection<?> aPathQuery, Collection<?> aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryBetween

      public HalData queryBetween(Object aFromPath, Object aPathQuery, Object aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryBetween

      public HalData queryBetween(Object[] aFromPath, Object[] aPathQuery, Object[] aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryBetween

      public HalData queryBetween(String aFromPath, String aPathQuery, String aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryBetween

      public HalData queryBetween(String aFromPath, Pattern aRegExp, String aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryBetween

      public HalData queryBetween(String[] aFromPath, String[] aPathQuery, String[] aToPath)
      Specified by:
      queryBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryBetween in class HalMap

    • queryFrom

      public HalData queryFrom(Collection<?> aPathQuery, Collection<?> aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryFrom

      public HalData queryFrom(Object aPathQuery, Object aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryFrom

      public HalData queryFrom(Object[] aPathQuery, Object[] aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryFrom

      public HalData queryFrom(String aPathQuery, String aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryFrom

      public HalData queryFrom(Pattern aRegExp, String aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryFrom

      public HalData queryFrom(String[] aPathQuery, String[] aFromPath)
      Specified by:
      queryFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryFrom in class HalMap

    • queryTo

      public HalData queryTo(Collection<?> aPathQuery, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • queryTo

      public HalData queryTo(Object aPathQuery, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • queryTo

      public HalData queryTo(Object[] aPathQuery, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • queryTo

      public HalData queryTo(String aPathQuery, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • queryTo

      public HalData queryTo(Pattern aRegExp, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • queryTo

      public HalData queryTo(String[] aPathQuery, String aToPath)
      Specified by:
      queryTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      queryTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      queryTo in class HalMap

    • removePaths

      public HalData removePaths(Collection<?> aPaths)
      Specified by:
      removePaths in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removePaths in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removePaths in class HalMap

    • removePaths

      public HalData removePaths(String... aPaths)
      Specified by:
      removePaths in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removePaths in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removePaths in class HalMap

    • removeAll

      public HalData removeAll(String... aPathQueryElements)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeAll

      public HalData removeAll(Object... aPathQueryElements)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeAll

      public HalData removeAll(Collection<?> aPathQueryElements)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeAll

      public HalData removeAll(String aPathQuery)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeAll

      public HalData removeAll(Pattern aRegExp)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeAll

      public HalData removeAll(Object aPathQuery)
      Specified by:
      removeAll in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeAll in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeAll in class HalMap

    • removeDirAt

      public HalData removeDirAt(int aIndex)
      Specified by:
      removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeDirAt in class HalMap

    • removeDirAt

      public HalData removeDirAt(Object aPath, int aIndex)
      Specified by:
      removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeDirAt in class HalMap

    • removeDirAt

      public HalData removeDirAt(Object[] aPathElements, int aIndex)
      Specified by:
      removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeDirAt in class HalMap

    • removeDirAt

      public HalData removeDirAt(String aPath, int aIndex)
      Specified by:
      removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeDirAt in class HalMap

    • removeDirAt

      public HalData removeDirAt(String[] aPathElements, int aIndex)
      Specified by:
      removeDirAt in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeDirAt in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeDirAt in class HalMap

    • removeFrom

      public HalData removeFrom(Object... aPathElements)
      Specified by:
      removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeFrom in class HalMap

    • removeFrom

      public HalData removeFrom(Object aPath)
      Specified by:
      removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeFrom in class HalMap

    • removeFrom

      public HalData removeFrom(String aPath)
      Specified by:
      removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeFrom in class HalMap

    • removeFrom

      public HalData removeFrom(String... aPathElements)
      Specified by:
      removeFrom in interface org.refcodes.struct.CanonicalMap.MutableCanonicalMap
      Specified by:
      removeFrom in interface org.refcodes.struct.PathMap.MutablePathMap<String>
      Overrides:
      removeFrom in class HalMap

    • retrieveBetween

      public HalData retrieveBetween(Collection<?> aFromPath, Collection<?> aToPath)
      Specified by:
      retrieveBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveBetween in class HalMap

    • retrieveBetween

      public HalData retrieveBetween(Object aFromPath, Object aToPath)
      Specified by:
      retrieveBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveBetween in class HalMap

    • retrieveBetween

      public HalData retrieveBetween(Object[] aFromPath, Object[] aToPath)
      Specified by:
      retrieveBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveBetween in class HalMap

    • retrieveBetween

      public HalData retrieveBetween(String[] aFromPath, String[] aToPath)
      Specified by:
      retrieveBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveBetween in class HalMap

    • retrieveFrom

      public HalData retrieveFrom(Collection<?> aPathElements)
      Specified by:
      retrieveFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveFrom in class HalMap

    • retrieveFrom

      public HalData retrieveFrom(Object aParentPath)
      Specified by:
      retrieveFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveFrom in class HalMap

    • retrieveFrom

      public HalData retrieveFrom(Object... aPathElements)
      Specified by:
      retrieveFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveFrom in class HalMap

    • retrieveFrom

      public HalData retrieveFrom(String... aPathElements)
      Specified by:
      retrieveFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveFrom in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveFrom in class HalMap

    • retrieveTo

      public HalData retrieveTo(Collection<?> aToPathElements)
      Specified by:
      retrieveTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveTo in class HalMap

    • retrieveTo

      public HalData retrieveTo(Object aToPath)
      Specified by:
      retrieveTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveTo in class HalMap

    • retrieveTo

      public HalData retrieveTo(Object... aToPathElements)
      Specified by:
      retrieveTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveTo in class HalMap

    • retrieveTo

      public HalData retrieveTo(String... aToPathElements)
      Specified by:
      retrieveTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveTo in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveTo in class HalMap

    • withPut

      public HalData withPut(Collection<?> aPathElements, String aValue)
      Specified by:
      withPut in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPut in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPut in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPut in class HalMap

    • withPut

      public HalData withPut(Object[] aPathElements, String aValue) throws NumberFormatException
      Specified by:
      withPut in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPut in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPut in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPut in class HalMap
      Throws:
      NumberFormatException

    • withPut

      public HalData withPut(org.refcodes.struct.Relation<String,String> aProperty)
      Specified by:
      withPut in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      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>
      Specified by:
      withPut in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPut in class HalMap

    • withPut

      public HalData withPut(org.refcodes.struct.Property aProperty)
      Specified by:
      withPut in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Overrides:
      withPut in class HalMap

    • withPut

      public HalData withPut(String[] aKey, String aValue)
      Specified by:
      withPut in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPut in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPut in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPut in class HalMap

    • withPutBoolean

      public HalData withPutBoolean(Collection<?> aPathElements, Boolean aValue)
      Specified by:
      withPutBoolean in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutBoolean in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutBoolean in class HalMap

    • withPutBoolean

      public HalData withPutBoolean(Object aKey, Boolean aValue)
      Specified by:
      withPutBoolean in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutBoolean in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutBoolean in class HalMap

    • withPutBoolean

      public HalData withPutBoolean(Object[] aPathElements, Boolean aValue)
      Specified by:
      withPutBoolean in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutBoolean in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutBoolean in class HalMap

    • withPutBoolean

      public HalData withPutBoolean(String aKey, Boolean aValue)
      Specified by:
      withPutBoolean in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutBoolean in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutBoolean in class HalMap

    • withPutBoolean

      public HalData withPutBoolean(String[] aPathElements, Boolean aValue)
      Specified by:
      withPutBoolean in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutBoolean in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutBoolean in class HalMap

    • withPutByte

      public HalData withPutByte(Collection<?> aPathElements, Byte aValue)
      Specified by:
      withPutByte in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutByte in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutByte in class HalMap

    • withPutByte

      public HalData withPutByte(Object aKey, Byte aValue)
      Specified by:
      withPutByte in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutByte in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutByte in class HalMap

    • withPutByte

      public HalData withPutByte(Object[] aPathElements, Byte aValue)
      Specified by:
      withPutByte in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutByte in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutByte in class HalMap

    • withPutByte

      public HalData withPutByte(String aKey, Byte aValue)
      Specified by:
      withPutByte in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutByte in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutByte in class HalMap

    • withPutByte

      public HalData withPutByte(String[] aPathElements, Byte aValue)
      Specified by:
      withPutByte in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutByte in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutByte in class HalMap

    • withPutChar

      public HalData withPutChar(Collection<?> aPathElements, Character aValue)
      Specified by:
      withPutChar in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutChar in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutChar in class HalMap

    • withPutChar

      public HalData withPutChar(Object aKey, Character aValue)
      Specified by:
      withPutChar in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutChar in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutChar in class HalMap

    • withPutChar

      public HalData withPutChar(Object[] aPathElements, Character aValue)
      Specified by:
      withPutChar in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutChar in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutChar in class HalMap

    • withPutChar

      public HalData withPutChar(String aKey, Character aValue)
      Specified by:
      withPutChar in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutChar in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutChar in class HalMap

    • withPutChar

      public HalData withPutChar(String[] aPathElements, Character aValue)
      Specified by:
      withPutChar in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutChar in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutChar in class HalMap

    • withPutClass

      public <C> HalData withPutClass(Collection<?> aPathElements, Class<C> aValue)
      Specified by:
      withPutClass in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutClass in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutClass in class HalMap

    • withPutClass

      public <C> HalData withPutClass(Object aKey, Class<C> aValue)
      Specified by:
      withPutClass in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutClass in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutClass in class HalMap

    • withPutClass

      public <C> HalData withPutClass(Object[] aPathElements, Class<C> aValue)
      Specified by:
      withPutClass in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutClass in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutClass in class HalMap

    • withPutClass

      public <C> HalData withPutClass(String aKey, Class<C> aValue)
      Specified by:
      withPutClass in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutClass in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutClass in class HalMap

    • withPutClass

      public <C> HalData withPutClass(String[] aPathElements, Class<C> aValue)
      Specified by:
      withPutClass in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutClass in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutClass in class HalMap

    • withPutDouble

      public HalData withPutDouble(Collection<?> aPathElements, Double aValue)
      Specified by:
      withPutDouble in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDouble in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutDouble in class HalMap

    • withPutDouble

      public HalData withPutDouble(Object aKey, Double aValue)
      Specified by:
      withPutDouble in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDouble in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutDouble in class HalMap

    • withPutDouble

      public HalData withPutDouble(Object[] aPathElements, Double aValue)
      Specified by:
      withPutDouble in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDouble in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutDouble in class HalMap

    • withPutDouble

      public HalData withPutDouble(String aKey, Double aValue)
      Specified by:
      withPutDouble in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDouble in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutDouble in class HalMap

    • withPutDouble

      public HalData withPutDouble(String[] aPathElements, Double aValue)
      Specified by:
      withPutDouble in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDouble in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutDouble in class HalMap

    • withPutEnum

      public <E extends Enum<E>> HalData withPutEnum(Collection<?> aPathElements, E aValue)
      Specified by:
      withPutEnum in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutEnum in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutEnum in class HalMap

    • withPutEnum

      public <E extends Enum<E>> HalData withPutEnum(Object aKey, E aValue)
      Specified by:
      withPutEnum in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutEnum in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutEnum in class HalMap

    • withPutEnum

      public <E extends Enum<E>> HalData withPutEnum(Object[] aPathElements, E aValue)
      Specified by:
      withPutEnum in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutEnum in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutEnum in class HalMap

    • withPutEnum

      public <E extends Enum<E>> HalData withPutEnum(String aKey, E aValue)
      Specified by:
      withPutEnum in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutEnum in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutEnum in class HalMap

    • withPutEnum

      public <E extends Enum<E>> HalData withPutEnum(String[] aPathElements, E aValue)
      Specified by:
      withPutEnum in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutEnum in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutEnum in class HalMap

    • withPutFloat

      public HalData withPutFloat(Collection<?> aPathElements, Float aValue)
      Specified by:
      withPutFloat in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutFloat in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutFloat in class HalMap

    • withPutFloat

      public HalData withPutFloat(Object aKey, Float aValue)
      Specified by:
      withPutFloat in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutFloat in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutFloat in class HalMap

    • withPutFloat

      public HalData withPutFloat(Object[] aPathElements, Float aValue)
      Specified by:
      withPutFloat in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutFloat in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutFloat in class HalMap

    • withPutFloat

      public HalData withPutFloat(String aKey, Float aValue)
      Specified by:
      withPutFloat in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutFloat in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutFloat in class HalMap

    • withPutFloat

      public HalData withPutFloat(String[] aPathElements, Float aValue)
      Specified by:
      withPutFloat in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutFloat in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutFloat in class HalMap

    • withPutInt

      public HalData withPutInt(Collection<?> aPathElements, Integer aValue)
      Specified by:
      withPutInt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutInt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutInt in class HalMap

    • withPutInt

      public HalData withPutInt(Object aKey, Integer aValue)
      Specified by:
      withPutInt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutInt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutInt in class HalMap

    • withPutInt

      public HalData withPutInt(Object[] aPathElements, Integer aValue)
      Specified by:
      withPutInt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutInt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutInt in class HalMap

    • withPutInt

      public HalData withPutInt(String aKey, Integer aValue)
      Specified by:
      withPutInt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutInt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutInt in class HalMap

    • withPutInt

      public HalData withPutInt(String[] aPathElements, Integer aValue)
      Specified by:
      withPutInt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutInt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutInt in class HalMap

    • withPutLong

      public HalData withPutLong(Collection<?> aPathElements, Long aValue)
      Specified by:
      withPutLong in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutLong in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutLong in class HalMap

    • withPutLong

      public HalData withPutLong(Object aKey, Long aValue)
      Specified by:
      withPutLong in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutLong in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutLong in class HalMap

    • withPutLong

      public HalData withPutLong(Object[] aPathElements, Long aValue)
      Specified by:
      withPutLong in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutLong in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutLong in class HalMap

    • withPutLong

      public HalData withPutLong(String aKey, Long aValue)
      Specified by:
      withPutLong in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutLong in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutLong in class HalMap

    • withPutLong

      public HalData withPutLong(String[] aPathElements, Long aValue)
      Specified by:
      withPutLong in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutLong in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutLong in class HalMap

    • withPutShort

      public HalData withPutShort(Collection<?> aPathElements, Short aValue)
      Specified by:
      withPutShort in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutShort in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutShort in class HalMap

    • withPutShort

      public HalData withPutShort(Object aKey, Short aValue)
      Specified by:
      withPutShort in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutShort in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutShort in class HalMap

    • withPutShort

      public HalData withPutShort(Object[] aPathElements, Short aValue)
      Specified by:
      withPutShort in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutShort in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutShort in class HalMap

    • withPutShort

      public HalData withPutShort(String aKey, Short aValue)
      Specified by:
      withPutShort in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutShort in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutShort in class HalMap

    • withPutShort

      public HalData withPutShort(String[] aPathElements, Short aValue)
      Specified by:
      withPutShort in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutShort in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutShort in class HalMap

    • withPutString

      public HalData withPutString(Collection<?> aPathElements, String aValue)
      Specified by:
      withPutString in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutString in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutString in class HalMap

    • withPutString

      public HalData withPutString(Object aKey, String aValue)
      Specified by:
      withPutString in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutString in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutString in class HalMap

    • withPutString

      public HalData withPutString(Object[] aPathElements, String aValue)
      Specified by:
      withPutString in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutString in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutString in class HalMap

    • withPutString

      public HalData withPutString(String aKey, String aValue)
      Specified by:
      withPutString in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutString in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutString in class HalMap

    • withPutString

      public HalData withPutString(String[] aPathElements, String aValue)
      Specified by:
      withPutString in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutString in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Overrides:
      withPutString in class HalMap

    • withInsert

      public HalData withInsert(Object aObj)
      Specified by:
      withInsert in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsert in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsert in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsert in class HalMap

    • withInsert

      public HalData withInsert(org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsert in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsert in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsert in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsert in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Collection<?> aToPathElements, Object aFrom, Collection<?> aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Object aToPath, Object aFrom, Object aFromPath)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Object aToPath, org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Object[] aToPathElements, Object aFrom, Object[] aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Object[] aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(String aToPath, Object aFrom, String aFromPath)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(String aToPath, org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(String[] aToPathElements, Object aFrom, String[] aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertBetween

      public HalData withInsertBetween(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, String[] aFromPathElements)
      Specified by:
      withInsertBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertBetween in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(Object aFrom, Collection<?> aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(Object aFrom, Object aFromPath)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(Object aFrom, Object... aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(Object aFrom, String aFromPath)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(Object aFrom, String... aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, Object... aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertFrom

      public HalData withInsertFrom(org.refcodes.struct.PathMap<String> aFrom, String... aFromPathElements)
      Specified by:
      withInsertFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertFrom in class HalMap

    • withInsertTo

      public HalData withInsertTo(Collection<?> aToPathElements, Object aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(Object aToPath, Object aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(Object aToPath, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(Object[] aToPathElements, Object aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(String aToPath, Object aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(String aToPath, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(String[] aToPathElements, Object aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withInsertTo

      public HalData withInsertTo(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withInsertTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withInsertTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withInsertTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withInsertTo in class HalMap

    • withMerge

      public HalData withMerge(Object aObj)
      Specified by:
      withMerge in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMerge in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMerge in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMerge in class HalMap

    • withMerge

      public HalData withMerge(org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMerge in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMerge in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMerge in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMerge in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Collection<?> aToPathElements, Object aFrom, Collection<?> aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Object aToPath, Object aFrom, Object aFromPath)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Object aToPath, org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Object[] aToPathElements, Object aFrom, Object[] aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, Object[] aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(String aToPath, Object aFrom, String aFromPath)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(String aToPath, org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(String[] aToPathElements, Object aFrom, String[] aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeBetween

      public HalData withMergeBetween(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom, String[] aFromPathElements)
      Specified by:
      withMergeBetween in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeBetween in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeBetween in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeBetween in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(Object aFrom, Collection<?> aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(Object aFrom, Object aFromPath)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(Object aFrom, Object... aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(Object aFrom, String aFromPath)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(Object aFrom, String... aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Collection<?> aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Object aFromPath)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, Object... aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, String aFromPath)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeFrom

      public HalData withMergeFrom(org.refcodes.struct.PathMap<String> aFrom, String... aFromPathElements)
      Specified by:
      withMergeFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeFrom in class HalMap

    • withMergeTo

      public HalData withMergeTo(Collection<?> aToPathElements, Object aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(Collection<?> aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(Object aToPath, Object aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(Object aToPath, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(Object[] aToPathElements, Object aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(Object[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(String aToPath, Object aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(String aToPath, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(String[] aToPathElements, Object aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withMergeTo

      public HalData withMergeTo(String[] aToPathElements, org.refcodes.struct.PathMap<String> aFrom)
      Specified by:
      withMergeTo in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withMergeTo in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withMergeTo in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withMergeTo in class HalMap

    • withPutDirAt

      public HalData withPutDirAt(Collection<?> aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(Collection<?> aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(Object aPath, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(Object aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(Object[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(Object[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(String aPath, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(String aPath, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(String[] aPathElements, int aIndex, Object aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withPutDirAt

      public HalData withPutDirAt(String[] aPathElements, int aIndex, org.refcodes.struct.PathMap<String> aDir) throws IllegalArgumentException
      Specified by:
      withPutDirAt in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withPutDirAt in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withPutDirAt in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withPutDirAt in class HalMap
      Throws:
      IllegalArgumentException

    • withRemoveFrom

      public HalData withRemoveFrom(Collection<?> aPathElements)
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemoveFrom in class HalMap

    • withRemoveFrom

      public HalData withRemoveFrom(Object aPath)
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemoveFrom in class HalMap

    • withRemoveFrom

      public HalData withRemoveFrom(Object... aPathElements)
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemoveFrom in class HalMap

    • withRemoveFrom

      public HalData withRemoveFrom(String aPath)
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemoveFrom in class HalMap

    • withRemoveFrom

      public HalData withRemoveFrom(String... aPathElements)
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<String>
      Specified by:
      withRemoveFrom in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemoveFrom in class HalMap

    • withRemovePaths

      public HalData withRemovePaths(String... aPathElements)
      Specified by:
      withRemovePaths in interface org.refcodes.struct.CanonicalMap.CanonicalMapBuilder
      Specified by:
      withRemovePaths in interface org.refcodes.struct.PathMap.PathMapBuilder<String>
      Overrides:
      withRemovePaths in class HalMap

    • retrieveFrom

      public HalData 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 HalMap

    • retrieveTo

      public HalData 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 HalMap

    • retrieveBetween

      public HalData retrieveBetween(String aFromPath, String aToPath)
      Specified by:
      retrieveBetween in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveBetween in interface org.refcodes.struct.PathMap<String>
      Overrides:
      retrieveBetween in class HalMap

    • withPut

      public HalData 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 HalMap