Package me.datafox.dfxengine.handles

Class HandleImpl

java.lang.Object
me.datafox.dfxengine.handles.HandleImpl
All Implemented Interfaces:
Comparable<Handle>, Handle
public class HandleImpl extends Object implements Handle
Implementation of Handle.

  • Method Details

    • getSubHandles

      public HandleSet getSubHandles()
      Specified by:
      getSubHandles in interface Handle
      Returns:
      subhandles contained in this handle

    • createSubHandle

      public Handle createSubHandle(String id)
      Creates a new subhandle. Throws UnsupportedOperationException if this handle is a subhandle or is associated with a Space (subhandles for space handles are used exclusively for Groups, use Space.createGroup(String) instead).
      Specified by:
      createSubHandle in interface Handle
      Parameters:
      id - String id for the new subhandle
      Returns:
      created subhandle
      Throws:
      NullPointerException - if the id is null
      IllegalArgumentException - if the id is empty, blank, contains non-ASCII or non-printable characters or the colon (:), or if a subhandle with the given id already exists in this handle
      UnsupportedOperationException - if this handle is a subhandle or if this handle is associated with a Space

    • getOrCreateSubHandle

      public Handle getOrCreateSubHandle(String id)
      Creates a subhandle with the specified id if it does not already exist and returns the subhandle with that id. Throws UnsupportedOperationException if this handle is a subhandle or is associated with a Space (subhandles for space handles are used exclusively for Groups) and a subhandle with the specified id is not present. Use Space.getOrCreateGroup(String).
      Specified by:
      getOrCreateSubHandle in interface Handle
      Parameters:
      id - String id for the subhandle
      Returns:
      created or pre-existing subhandle
      Throws:
      NullPointerException - if the id is null
      IllegalArgumentException - if the id is empty, blank, contains non-ASCII or non-printable characters or the colon (:)
      UnsupportedOperationException - if this handle is a subhandle or if this handle is associated with a Space and a subhandle with the specified id is not present

    • isSubHandle

      public boolean isSubHandle()
      Specified by:
      isSubHandle in interface Handle
      Returns:
      true if this handle is a subhandle

    • compareTo

      public int compareTo(Handle o)
      Compares this handle with the specified handle for order. Returns a negative integer, zero, or a positive integer as this handle is less than, equal to, or greater than the specified handle. The order of handles is specified by three things. If the Spaces of the handles are different, comparison is done with the space's handle. If the spaces are the same, comparison is done with the index, using the sub-index if the indices are also the same.
      Specified by:
      compareTo in interface Comparable<Handle>
      Specified by:
      compareTo in interface Handle
      Parameters:
      o - handle to be compared.
      Returns:
      negative integer, zero, or a positive integer as this handle is less than, equal to, or greater than the specified handle
      Throws:
      NullPointerException - if the specified handle is null

    • toString

      public String toString()
      Overrides:
      toString in class Object