Constructor Detail

• HashTree

  HashTree()

  Creates an empty new HashTree.

• HashTree

  HashTree(Object key)

  Creates a new HashTree and adds the given object as a top-level node.

  Parameters:

  key - name of the new top-level node

• HashTree

  HashTree(Collection<out Object> keys)

  Creates a new HashTree and adds all the objects in the given collection as top-level nodes in the tree.

  Parameters:

  keys - a collection of objects to be added to the created HashTree.

• HashTree

  HashTree(Array<Object> keys)

  Creates a new HashTree and adds all the objects in the given array as top-level nodes in the tree.

  Parameters:

  keys - array with names for the new top-level nodes

Method Detail

• putAll

   void putAll(Map<out Object, out HashTree> map)

  The Map given must also be a HashTree, otherwise an UnsupportedOperationException is thrown. If it is a HashTree, this is like calling the add(HashTree) method.

• entrySet

   Set<Map.Entry<Object, HashTree>> entrySet()

  Exists to satisfy the Map interface.

• containsValue

   boolean containsValue(Object value)

  Implemented as required by the Map interface, but is not very useful here. All 'values' in a HashTree are HashTree's themselves.

  Parameters:

  value - Object to be tested as a value.

  Returns:

  True if the HashTree contains the value, false otherwise.

• put

   HashTree put(Object key, HashTree value)

  This is the same as calling HashTree.add(key,value).

  Parameters:

  key - to use

  value - to store against key

• clear

   void clear()

  Clears the HashTree of all contents.

• values

   Collection<HashTree> values()

  Returns a collection of all the sub-trees of the current tree.

• add

   void add(Object key, HashTree subTree)

  Adds a key as a node at the current level and then adds the given HashTree to that new node.

  Parameters:

  key - key to create in this tree

  subTree - sub tree to add to the node created for the first argument.

• add

   void add(HashTree newTree)

  Adds all the nodes and branches of the given tree to this tree. Is like merging two trees. Duplicates are ignored.

  Parameters:

  newTree - the tree to be added

• containsKey

   boolean containsKey(Object o)

  If the HashTree contains the given object as a key at the top level, then a true result is returned, otherwise false.

  Parameters:

  o - Object to be tested as a key.

  Returns:

  True if the HashTree contains the key, false otherwise.

• isEmpty

   boolean isEmpty()

  If the HashTree is empty, true is returned, false otherwise.

  Returns:

  True if HashTree is empty, false otherwise.

• set

   void set(Object key, Object value)

  Sets a key and it's value in the HashTree. It actually sets up a key, and then creates a node for the key and sets the value to the new node, as a key. Any previous nodes that existed under the given key are lost.

  Parameters:

  key - key to be set up

  value - value to be set up as a key in the secondary node

• set

   void set(Object key, HashTree t)

  Sets a key into the current tree and assigns it a HashTree as its subtree. Any previous entries under the given key are removed.

  Parameters:

  key - key to be set up

  t - HashTree that the key maps to

• set

   void set(Object key, Array<Object> values)

  Sets a key and its values in the HashTree. It sets up a key in the current node, and then creates a node for that key, and sets all the values in the array as keys in the new node. Any keys previously held under the given key are lost.

  Parameters:

  key - Key to be set up

  values - Array of objects to be added as keys in the secondary node

• set

   void set(Object key, Collection<out Object> values)

  Sets a key and its values in the HashTree. It sets up a key in the current node, and then creates a node for that key, and set all the values in the array as keys in the new node. Any keys previously held under the given key are removed.

  Parameters:

  key - key to be set up

  values - Collection of objects to be added as keys in the secondary node

• set

   void set(Array<Object> treePath, Array<Object> values)

  Sets a series of keys into the HashTree. It sets up the first object in the key array as a key in the current node, recurses into the next HashTree node through that key and adds the second object in the array. Continues recursing in this manner until the end of the first array is reached, at which point all the values of the second array are set as keys to the bottom-most node. All previous keys of that bottom-most node are removed.

  Parameters:

  treePath - array of keys to put into HashTree

  values - array of values to be added as keys to bottom-most node

• set

   void set(Array<Object> treePath, Collection<out Object> values)

  Sets a series of keys into the HashTree. It sets up the first object in the key array as a key in the current node, recurses into the next HashTree node through that key and adds the second object in the array. Continues recursing in this manner until the end of the first array is reached, at which point all the values of the Collection of values are set as keys to the bottom-most node. Any keys previously held by the bottom-most node are lost.

  Parameters:

  treePath - array of keys to put into HashTree

  values - Collection of values to be added as keys to bottom-most node

• set

   void set(Collection<out Object> treePath, Array<Object> values)

  Sets a series of keys into the HashTree. It sets up the first object in the key list as a key in the current node, recurses into the next HashTree node through that key and adds the second object in the list. Continues recursing in this manner until the end of the first list is reached, at which point all the values of the array of values are set as keys to the bottom-most node. Any previously existing keys of that bottom node are removed.

  Parameters:

  treePath - collection of keys to put into HashTree

  values - array of values to be added as keys to bottom-most node

• set

   void set(Collection<out Object> values)

  Sets the nodes of the current tree to be the objects of the given collection. Any nodes previously in the tree are removed.

  Parameters:

  values - Collection of objects to set as nodes.

• set

   void set(Collection<out Object> treePath, Collection<out Object> values)

  Sets a series of keys into the HashTree. It sets up the first object in the key list as a key in the current node, recurses into the next HashTree node through that key and adds the second object in the list. Continues recursing in this manner until the end of the first list is reached, at which point all the values of the Collection of values are set as keys to the bottom-most node. Any previously existing keys of that bottom node are lost.

  Parameters:

  treePath - list of keys to put into HashTree

  values - collection of values to be added as keys to bottom-most node

• add

   HashTree add(Object key)

  Adds an key into the HashTree at the current level. If a HashTree exists for the key already, no new tree will be added

  Parameters:

  key - key to be added to HashTree

  Returns:

  newly generated tree, if no tree was found for the given key; existing key otherwise

• add

   void add(Array<Object> keys)

  Adds all the given objects as nodes at the current level.

  Parameters:

  keys - Array of Keys to be added to HashTree.

• add

   void add(Collection<out Object> keys)

  Adds a bunch of keys into the HashTree at the current level.

  Parameters:

  keys - Collection of Keys to be added to HashTree.

• add

   HashTree add(Object key, Object value)

  Adds a key and it's value in the HashTree. The first argument becomes a node at the current level, and the second argument becomes a node of it.

  Parameters:

  key - key to be added

  value - value to be added as a key in the secondary node

  Returns:

  HashTree for which value is the key

• add

   void add(Object key, Array<Object> values)

  Adds a key and it's values in the HashTree. The first argument becomes a node at the current level, and adds all the values in the array to the new node.

  Parameters:

  key - key to be added

  values - array of objects to be added as keys in the secondary node

• add

   void add(Object key, Collection<out Object> values)

  Adds a key as a node at the current level and then adds all the objects in the second argument as nodes of the new node.

  Parameters:

  key - key to be added

  values - Collection of objects to be added as keys in the secondary node

• add

   void add(Array<Object> treePath, Array<Object> values)

  Adds a series of nodes into the HashTree using the given path. The first argument is an array that represents a path to a specific node in the tree. If the path doesn't already exist, it is created (the objects are added along the way). At the path, all the objects in the second argument are added as nodes.

  Parameters:

  treePath - an array of objects representing a path

  values - array of values to be added as keys to bottom-most node

• add

   void add(Array<Object> treePath, Collection<out Object> values)

  Adds a series of nodes into the HashTree using the given path. The first argument is an array that represents a path to a specific node in the tree. If the path doesn't already exist, it is created (the objects are added along the way). At the path, all the objects in the second argument are added as nodes.

  Parameters:

  treePath - an array of objects representing a path

  values - collection of values to be added as keys to bottom-most node

• add

   HashTree add(Array<Object> treePath, Object value)

• add

   void add(Collection<out Object> treePath, Array<Object> values)

  Adds a series of nodes into the HashTree using the given path. The first argument is a List that represents a path to a specific node in the tree. If the path doesn't already exist, it is created (the objects are added along the way). At the path, all the objects in the second argument are added as nodes.

  Parameters:

  treePath - a list of objects representing a path

  values - array of values to be added as keys to bottom-most node

• add

   HashTree add(Collection<out Object> treePath, Object value)

  Adds a series of nodes into the HashTree using the given path. The first argument is a List that represents a path to a specific node in the tree. If the path doesn't already exist, it is created (the objects are added along the way). At the path, the object in the second argument is added as a node.

  Parameters:

  treePath - a list of objects representing a path

  value - Object to add as a node to bottom-most node

  Returns:

  HashTree for which value is the key

• add

   void add(Collection<out Object> treePath, Collection<out Object> values)

  Adds a series of nodes into the HashTree using the given path. The first argument is a SortedSet that represents a path to a specific node in the tree. If the path doesn't already exist, it is created (the objects are added along the way). At the path, all the objects in the second argument are added as nodes.

  Parameters:

  treePath - a SortedSet of objects representing a path

  values - Collection of values to be added as keys to bottom-most node

• getTree

   HashTree getTree(Object key)

  Gets the HashTree mapped to the given key.

  Parameters:

  key - Key used to find appropriate HashTree()

  Returns:

  the HashTree for key

• get

   HashTree get(Object key)

  Returns the HashTree object associated with the given key. Same as calling getTree.

• getTree

   HashTree getTree(Array<Object> treePath)

  Gets the HashTree object mapped to the last key in the array by recursing through the HashTree structure one key at a time.

  Parameters:

  treePath - array of keys.

  Returns:

  HashTree at the end of the recursion.

• clone

   Object clone()

  Create a clone of this HashTree. This is not a deep clone (i.e., the contents of the tree are not cloned).

• getTree

   HashTree getTree(Collection<out Object> treePath)

  Gets the HashTree object mapped to the last key in the SortedSet by recursing through the HashTree structure one key at a time.

  Parameters:

  treePath - Collection of keys

  Returns:

  HashTree at the end of the recursion

• list

   Collection<Object> list()

  Gets a Collection of all keys in the current HashTree node. If the HashTree represented a file system, this would be like getting a collection of all the files in the current folder.

  Returns:

  Set of all keys in this HashTree

• list

   Collection<out Object> list(Object key)

  Gets a Set of all keys in the HashTree mapped to the given key of the current HashTree object (in other words, one level down. If the HashTree represented a file system, this would like getting a list of all files in a sub-directory (of the current directory) specified by the key argument.

  Parameters:

  key - key used to find HashTree to get list of

  Returns:

  Set of all keys in found HashTree.

• remove

   HashTree remove(Object key)

  Removes the entire branch specified by the given key.

• list

   Collection<out Object> list(Array<Object> treePath)

  Recurses down into the HashTree structure using each subsequent key in the array of keys, and returns the Set of keys of the HashTree object at the end of the recursion. If the HashTree represented a file system, this would be like getting a list of all the files in a directory specified by the treePath, relative from the current directory.

  Parameters:

  treePath - Array of keys used to recurse into HashTree structure

  Returns:

  Set of all keys found in end HashTree

• list

   Collection<out Object> list(Collection<out Object> treePath)

  Recurses down into the HashTree structure using each subsequent key in the List of keys, and returns the Set of keys of the HashTree object at the end of the recursion. If the HashTree represented a file system, this would be like getting a list of all the files in a directory specified by the treePath, relative from the current directory.

  Parameters:

  treePath - List of keys used to recurse into HashTree structure

  Returns:

  Set of all keys found in end HashTree

• replaceKey

   void replaceKey(Object currentKey, Object newKey)

  Finds the given current key, and replaces it with the given new key. Any tree structure found under the original key is moved to the new key.

  Parameters:

  currentKey - name of the key to be replaced

  newKey - name of the new key

• getArray

   Array<Object> getArray()

  Gets an array of all keys in the current HashTree node. If the HashTree represented a file system, this would be like getting an array of all the files in the current folder.

  Returns:

  array of all keys in this HashTree.

• getArray

   Array<Object> getArray(Object key)

  Gets an array of all keys in the HashTree mapped to the given key of the current HashTree object (in other words, one level down). If the HashTree represented a file system, this would like getting a list of all files in a sub-directory (of the current directory) specified by the key argument.

  Parameters:

  key - key used to find HashTree to get list of

  Returns:

  array of all keys in found HashTree

• getArray

   Array<Object> getArray(Array<Object> treePath)

  Recurses down into the HashTree structure using each subsequent key in the array of keys, and returns an array of keys of the HashTree object at the end of the recursion. If the HashTree represented a file system, this would be like getting a list of all the files in a directory specified by the treePath, relative from the current directory.

  Parameters:

  treePath - array of keys used to recurse into HashTree structure

  Returns:

  array of all keys found in end HashTree

• getArray

   Array<Object> getArray(Collection<out Object> treePath)

  Recurses down into the HashTree structure using each subsequent key in the treePath argument, and returns an array of keys of the HashTree object at the end of the recursion. If the HashTree represented a file system, this would be like getting a list of all the files in a directory specified by the treePath, relative from the current directory.

  Parameters:

  treePath - list of keys used to recurse into HashTree structure

  Returns:

  array of all keys found in end HashTree

• hashCode

   int hashCode()

  Returns a hashcode for this HashTree.

• equals

   boolean equals(Object o)

  Compares all objects in the tree and verifies that the two trees contain the same objects at the same tree levels. Returns true if they do, false otherwise.

  Parameters:

  o - Object to be compared against

• keySet

   Set<Object> keySet()

  Returns a Set of all the keys in the top-level of this HashTree.

• search

   HashTree search(Object key)

  Searches the HashTree structure for the given key. If it finds the key, it returns the HashTree mapped to the key. If it finds nothing, it returns null.

  Parameters:

  key - Key to search for

  Returns:

  HashTree mapped to key, if found, otherwise null

• size

   int size()

  Returns the number of top-level entries in the HashTree.

• traverse

   void traverse(HashTreeTraverser visitor)

  Allows any implementation of the HashTreeTraverser interface to easily traverse (depth-first) all the nodes of the HashTree. The Traverser implementation will be given notification of each node visited.

  Parameters:

  visitor - the visitor that wants to traverse the tree

• toString

   String toString()

  Generate a printable representation of the tree.

  Returns:

  a representation of the tree