HashTree.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.jorphan.collections |
 |
 |
JMeter |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0132 | JAVA0132 Method overload with compatible signature | |
| LINE_COMMENT | Number of line comments | |
| RETURNS | Number of return points from functions | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LINES | Number of lines in the source file | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0236 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| LOGICAL_LINES | Number of statements | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.jorphan.collections;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
/**
* This class is used to create a tree structure of objects. Each element in the
* tree is also a key to the next node down in the tree. It provides many ways
* to add objects and branches, as well as many ways to retrieve.
* <p>
* HashTree implements the Map interface for convenience reasons. The main
* difference between a Map and a HashTree is that the HashTree organizes the
* data into a recursive tree structure, and provides the means to manipulate
* that structure.
* <p>
* Of special interest is the {@link #traverse(HashTreeTraverser)} method, which
* provides an expedient way to traverse any HashTree by implementing the
* {@link HashTreeTraverser} interface in order to perform some operation on the
* tree, or to extract information from the tree.
*
* @see HashTreeTraverser
* @see SearchByClass
*/
public class HashTree implements Serializable, Map {
// GetLoggerForClass() uses ClassContext, which
// causes a Security violation in RemoteJMeterImpl
// Currently log is only used by test code, so moved there.
// N.B. Can still add logging, but would beed to use getLoggerFor() instead
// private static Logger log =
// LoggingManager.getLoggerForClass();
// Used for the RuntimeException to short-circuit the traversal
private static final String FOUND = "found"; // $NON-NLS-1$
/**
* Creates an empty new HashTree.
*/
public HashTree() {
data = new HashMap();
}
/**
* Creates a new HashTree and adds the given object as a top-level node.
*
* @param key
*/
public HashTree(Object key) {
data = new HashMap();
data.put(key, new HashTree());
}
/**
* 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.
*
* @see #add(HashTree)
* @see java.util.Map#putAll(Map)
*/
public void putAll(Map map) {
if (map instanceof HashTree) {
this.add((HashTree) map);
} else {
throw new UnsupportedOperationException("can only putAll other HashTree objects");
}
}
/**
* Exists to satisfy the Map interface.
*
* @see java.util.Map#entrySet()
*/
public Set entrySet() {
return data.entrySet();
}
/**
* Implemented as required by the Map interface, but is not very useful
* here. All 'values' in a HashTree are HashTree's themselves.
*
* @param value
* Object to be tested as a value.
* @return True if the HashTree contains the value, false otherwise.
* @see java.util.Map#containsValue(Object)
*/
public boolean containsValue(Object value) {
return data.containsValue(value);
}
/**
* This is the same as calling HashTree.add(key,value).
*
* @param key
* to use
* @param value
* to store against key
* @see java.util.Map#put(Object, Object)
*/
public Object put(Object key, Object value) {
Object previous = data.get(key);
add(key, value);
return previous;
}
/**
* Clears the HashTree of all contents.
*
* @see java.util.Map#clear()
*/
public void clear() {
data.clear();
}
/**
* Returns a collection of all the sub-trees of the current tree.
*
* @see java.util.Map#values()
*/
public Collection values() {
return data.values();
}
/**
* Adds a key as a node at the current level and then adds the given
* HashTree to that new node.
*
* @param key
* key to create in this tree
* @param subTree
* sub tree to add to the node created for the first argument.
*/
public void add(Object key, HashTree subTree) {
add(key);
getTree(key).add(subTree);
}
/**
* Adds all the nodes and branches of the given tree to this tree. Is like
* merging two trees. Duplicates are ignored.
*
* @param newTree
*/
public void add(HashTree newTree) {
Iterator iter = newTree.list().iterator();
while (iter.hasNext()) {
Object item = iter.next();
add(item);
getTree(item).add(newTree.getTree(item));
}
}
/**
* Creates a new HashTree and adds all the objects in the given collection
* as top-level nodes in the tree.
*
* @param keys
* a collection of objects to be added to the created HashTree.
*/
public HashTree(Collection keys) {
data = new HashMap();
Iterator it = keys.iterator();
while (it.hasNext()) {
data.put(it.next(), new HashTree());
}
}
/**
* Creates a new HashTree and adds all the objects in the given array as
* top-level nodes in the tree.
*/
public HashTree(Object[] keys) {
data = new HashMap();
for (int x = 0; x < keys.length; x++) {
data.put(keys[x], new HashTree());
}
}
/**
* If the HashTree contains the given object as a key at the top level, then
* a true result is returned, otherwise false.
*
* @param o
* Object to be tested as a key.
* @return True if the HashTree contains the key, false otherwise.
* @see java.util.Map#containsKey(Object)
*/
public boolean containsKey(Object o) {
return data.containsKey(o);
}
/**
* If the HashTree is empty, true is returned, false otherwise.
*
* @return True if HashTree is empty, false otherwise.
*/
public boolean isEmpty() {
return data.isEmpty();
}
/**
* 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.
*
* @param key
* key to be set up
* @param value
* value to be set up as a key in the secondary node
*/
public void set(Object key, Object value) {
data.put(key, createNewTree(value));
}
/**
* Sets a key into the current tree and assigns it a HashTree as its
* subtree. Any previous entries under the given key are removed.
*
* @param key
* key to be set up
* @param t
* HashTree that the key maps to
*/
public void set(Object key, HashTree t) {
data.put(key, t);
}
/**
* Sets a key and it's 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.
*
* @param key
* Key to be set up
* @param values
* Array of objects to be added as keys in the secondary node
*/
public void set(Object key, Object[] values) {
data.put(key, createNewTree(Arrays.asList(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.
*
* @param key
* key to be set up
* @param values
* Collection of objects to be added as keys in the secondary
* node
*/
public void set(Object key, Collection values) {
data.put(key, createNewTree(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.
*
* @param treePath
* array of keys to put into HashTree
* @param values
* array of values to be added as keys to bottom-most node
*/
public void set(Object[] treePath, Object[] values) {
if (treePath != null && values != null) {
set(Arrays.asList(treePath), Arrays.asList(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.
*
* @param treePath
* array of keys to put into HashTree
* @param values
* Collection of values to be added as keys to bottom-most node
*/
public void set(Object[] treePath, Collection values) {
if (treePath != null) {
set(Arrays.asList(treePath), 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.
*
* @param treePath
* collection of keys to put into HashTree
* @param values
* array of values to be added as keys to bottom-most node
*/
public void set(Collection treePath, Object[] values) {
HashTree tree = addTreePath(treePath);
tree.set(Arrays.asList(values));
}
/**
* Sets the nodes of the current tree to be the objects of the given
* collection. Any nodes previously in the tree are removed.
*
* @param values
* Collection of objects to set as nodes.
*/
public void set(Collection values) {
clear();
this.add(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.
*
* @param treePath
* list of keys to put into HashTree
* @param values
* collection of values to be added as keys to bottom-most node
*/
public void set(Collection treePath, Collection values) {
HashTree tree = addTreePath(treePath);
tree.set(values);
}
/**
* Adds an key into the HashTree at the current level.
*
* @param key
* key to be added to HashTree
*/
public HashTree add(Object key) {
if (!data.containsKey(key)) {
HashTree newTree = createNewTree();
data.put(key, newTree);
return newTree;
}
return getTree(key);
}
/**
* Adds all the given objects as nodes at the current level.
*
* @param keys
* Array of Keys to be added to HashTree.
*/
public void add(Object[] keys) {
for (int x = 0; x < keys.length; x++) {
add(keys[x]);
}
}
/**
* Adds a bunch of keys into the HashTree at the current level.
*
* @param keys
* Collection of Keys to be added to HashTree.
*/
public void add(Collection keys) {
Iterator it = keys.iterator();
while (it.hasNext()) {
add(it.next());
}
}
/**
* 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.
*
* @param key
* key to be added
* @param value
* value to be added as a key in the secondary node
*/
public HashTree add(Object key, Object value) {
add(key);
return getTree(key).add(value);
}
/**
* 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.
*
* @param key
* key to be added
* @param values
* array of objects to be added as keys in the secondary node
*/
public void add(Object key, Object[] values) {
add(key);
getTree(key).add(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.
*
* @param key
* key to be added
* @param values
* Collection of objects to be added as keys in the secondary
* node
*/
public void add(Object key, Collection values) {
add(key);
getTree(key).add(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.
*
* @param treePath
* an array of objects representing a path
* @param values
* array of values to be added as keys to bottom-most node
*/
public void add(Object[] treePath, Object[] values) {
if (treePath != null) {
add(Arrays.asList(treePath), Arrays.asList(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.
*
* @param treePath
* an array of objects representing a path
* @param values
* collection of values to be added as keys to bottom-most node
*/
public void add(Object[] treePath, Collection values) {
if (treePath != null) {
add(Arrays.asList(treePath), values);
}
}
public HashTree add(Object[] treePath, Object value) {
return add(Arrays.asList(treePath), 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, all the objects in the second argument are
* added as nodes.
*
* @param treePath
* a list of objects representing a path
* @param values
* array of values to be added as keys to bottom-most node
*/
public void add(Collection treePath, Object[] values) {
HashTree tree = addTreePath(treePath);
tree.add(Arrays.asList(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, the object in the second argument is added
* as a node.
*
* @param treePath
* a list of objects representing a path
* @param value
* Object to add as a node to bottom-most node
*/
public HashTree add(Collection treePath, Object value) {
HashTree tree = addTreePath(treePath);
return tree.add(value);
}
/**
* 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.
*
* @param treePath
* a SortedSet of objects representing a path
* @param values
* Collection of values to be added as keys to bottom-most node
*/
public void add(Collection treePath, Collection values) {
HashTree tree = addTreePath(treePath);
tree.add(values);
}
protected HashTree addTreePath(Collection treePath) {
HashTree tree = this;
Iterator iter = treePath.iterator();
while (iter.hasNext()) {
Object temp = iter.next();
tree.add(temp);
tree = tree.getTree(temp);
}
return tree;
}
/**
* Gets the HashTree mapped to the given key.
*
* @param key
* Key used to find appropriate HashTree()
*/
public HashTree getTree(Object key) {
return (HashTree) data.get(key);
}
/**
* Returns the HashTree object associated with the given key. Same as
* calling {@link #getTree(Object)}.
*
* @see java.util.Map#get(Object)
*/
public Object get(Object key) {
return getTree(key);
}
/**
* Gets the HashTree object mapped to the last key in the array by recursing
* through the HashTree structure one key at a time.
*
* @param treePath
* array of keys.
* @return HashTree at the end of the recursion.
*/
public HashTree getTree(Object[] treePath) {
if (treePath != null) {
return getTree(Arrays.asList(treePath));
}
return this;
}
/**
* Create a clone of this HashTree. This is not a deep clone (ie, the
* contents of the tree are not cloned).
*
*/
public Object clone() {
HashTree newTree = new HashTree();
cloneTree(newTree);
return newTree;
}
protected void cloneTree(HashTree newTree) {
Iterator iter = list().iterator();
while (iter.hasNext()) {
Object key = iter.next();
newTree.set(key, (HashTree) getTree(key).clone());
}
}
/**
* Creates a new tree. This method exists to allow inheriting classes to
* generate the appropriate types of nodes. For instance, when a node is
* added, it's value is a HashTree. Rather than directly calling the
* HashTree() constructor, the createNewTree() method is called. Inheriting
* classes should override these methods and create the appropriate subclass
* of HashTree.
*
* @return HashTree
*/
protected HashTree createNewTree() {
return new HashTree();
}
/**
* Creates a new tree. This method exists to allow inheriting classes to
* generate the appropriate types of nodes. For instance, when a node is
* added, it's value is a HashTree. Rather than directly calling the
* HashTree() constructor, the createNewTree() method is called. Inheriting
* classes should override these methods and create the appropriate subclass
* of HashTree.
*
* @return HashTree
*/
protected HashTree createNewTree(Object key) {
return new HashTree(key);
}
/**
* Creates a new tree. This method exists to allow inheriting classes to
* generate the appropriate types of nodes. For instance, when a node is
* added, it's value is a HashTree. Rather than directly calling the
* HashTree() constructor, the createNewTree() method is called. Inheriting
* classes should override these methods and create the appropriate subclass
* of HashTree.
*
* @return HashTree
*/
protected HashTree createNewTree(Collection values) {
return new HashTree(values);
}
/**
* Gets the HashTree object mapped to the last key in the SortedSet by
* recursing through the HashTree structure one key at a time.
*
* @param treePath
* Collection of keys
* @return HashTree at the end of the recursion
*/
public HashTree getTree(Collection treePath) {
return getTreePath(treePath);
}
/**
* 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.
*
* @return Set of all keys in this HashTree
*/
public Collection list() {
return data.keySet();
}
/**
* 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.
*
* @param key
* key used to find HashTree to get list of
* @return Set of all keys in found HashTree.
*/
public Collection list(Object key) {
HashTree temp = (HashTree) data.get(key);
if (temp != null) {
return temp.list();
}
return new LinkedList();
}
/**
* Removes the entire branch specified by the given key.
*
* @see java.util.Map#remove(Object)
*/
public Object remove(Object key) {
return data.remove(key);
}
/**
* Recurses down into the HashTree stucture 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.
*
* @param treePath
* Array of keys used to recurse into HashTree structure
* @return Set of all keys found in end HashTree
*/
public Collection list(Object[] treePath) {
if (treePath != null) {
return list(Arrays.asList(treePath));
}
return list();
}
/**
* Recurses down into the HashTree stucture 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.
*
* @param treePath
* List of keys used to recurse into HashTree structure
* @return Set of all keys found in end HashTree
*/
public Collection list(Collection treePath) {
HashTree tree = getTreePath(treePath);
if (tree != null) {
return tree.list();
}
return new LinkedList();
}
/**
* 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.
*/
public void replace(Object currentKey, Object newKey) {
HashTree tree = getTree(currentKey);
data.remove(currentKey);
data.put(newKey, tree);
}
/**
* 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.
*
* @return array of all keys in this HashTree.
*/
public Object[] getArray() {
return data.keySet().toArray();
}
/**
* 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.
*
* @param key
* key used to find HashTree to get list of
* @return array of all keys in found HashTree
*/
public Object[] getArray(Object key) {
HashTree t = getTree(key);
if (t != null) {
return t.getArray();
}
return null;
}
/**
* Recurses down into the HashTree stucture 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.
*
* @param treePath
* array of keys used to recurse into HashTree structure
* @return array of all keys found in end HashTree
*/
public Object[] getArray(Object[] treePath) {
if (treePath != null) {
return getArray(Arrays.asList(treePath));
}
return getArray();
}
/**
* Recurses down into the HashTree stucture 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.
*
* @param treePath
* list of keys used to recurse into HashTree structure
* @return array of all keys found in end HashTree
*/
public Object[] getArray(Collection treePath) {
HashTree tree = getTreePath(treePath);
return (tree != null) ? tree.getArray() : null;
}
protected HashTree getTreePath(Collection treePath) {
HashTree tree = this;
Iterator iter = treePath.iterator();
while (iter.hasNext()) {
if (tree == null) {
return null;
}
Object temp = iter.next();
tree = tree.getTree(temp);
}
return tree;
}
/**
* Returns a hashcode for this HashTree.
*
* @see java.lang.Object#hashCode()
*/
public int hashCode() {
return data.hashCode() * 7;
}
/**
* 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.
*
* @param o
* Object to be compared against
* @see java.lang.Object#equals(Object)
*/
public boolean equals(Object o) {
if (!(o instanceof HashTree)) {
return false;
}
HashTree oo = (HashTree) o;
if (oo.size() != this.size()) {
return false;
}
return data.equals(oo.data);
// boolean flag = true;
// if (o instanceof HashTree)
// {
// HashTree oo = (HashTree) o;
// Iterator it = data.keySet().iterator();
// while (it.hasNext())
// {
// if (!oo.containsKey(it.next()))
// {
// flag = false;
// break;
// }
// }
// if (flag)
// {
// it = data.keySet().iterator();
// while (it.hasNext())
// {
// Object temp = it.next();
// flag = get(temp).equals(oo.get(temp));
// if (!flag)
// {
// break;
// }
// }
// }
// }
// else
// {
// flag = false;
// }
// return flag;
}
/**
* Returns a Set of all the keys in the top-level of this HashTree.
*
* @see java.util.Map#keySet()
*/
public Set keySet() {
return data.keySet();
}
/**
* 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.
*
* @param key
* Key to search for
* @return HashTree mapped to key, if found, otherwise <code>null</code>
*/
public HashTree search(Object key) {// TODO does not appear to be used
HashTree result = getTree(key);
if (result != null) {
return result;
}
TreeSearcher searcher = new TreeSearcher(key);
try {
traverse(searcher);
} catch (RuntimeException e) {
if (!e.getMessage().equals(FOUND)){
throw e;
}
// do nothing - means object is found
}
return searcher.getResult();
}
/**
* Method readObject.
*/
private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {
ois.defaultReadObject();
}
private void writeObject(ObjectOutputStream oos) throws IOException {
oos.defaultWriteObject();
}
/**
* Returns the number of top-level entries in the HashTree.
*
* @see java.util.Map#size()
*/
public int size() {
return data.size();
}
/**
* 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.
*
* @see HashTreeTraverser
*/
public void traverse(HashTreeTraverser visitor) {
Iterator iter = list().iterator();
while (iter.hasNext()) {
Object item = iter.next();
visitor.addNode(item, getTree(item));
getTree(item).traverseInto(visitor);
}
}
/**
* The recursive method that accomplishes the tree-traversal and performs
* the callbacks to the HashTreeTraverser.
*/
private void traverseInto(HashTreeTraverser visitor) {
if (list().size() == 0) {
visitor.processPath();
} else {
Iterator iter = list().iterator();
while (iter.hasNext()) {
Object item = iter.next();
visitor.addNode(item, getTree(item));
getTree(item).traverseInto(visitor);
}
}
visitor.subtractNode();
}
public String toString() {
ConvertToString converter = new ConvertToString();
traverse(converter);
return converter.toString();
}
protected Map data;
private static class TreeSearcher implements HashTreeTraverser {
Object target;
HashTree result;
public TreeSearcher(Object t) {
target = t;
}
public HashTree getResult() {
return result;
}
/*
* (non-Javadoc)
*
* @see org.apache.jorphan.collections.HashTreeTraverser#addNode(java.lang.Object,
* org.apache.jorphan.collections.HashTree)
*/
public void addNode(Object node, HashTree subTree) {
result = subTree.getTree(target);
if (result != null) {
// short circuit traversal when found
throw new RuntimeException(FOUND);
}
}
/*
* (non-Javadoc)
*
* @see org.apache.jorphan.collections.HashTreeTraverser#processPath()
*/
public void processPath() {
// Not used
}
/*
* (non-Javadoc)
*
* @see org.apache.jorphan.collections.HashTreeTraverser#subtractNode()
*/
public void subtractNode() {
// Not used
}
}
private static class ConvertToString implements HashTreeTraverser {
StringBuffer string = new StringBuffer(getClass().getName() + "{");
StringBuffer spaces = new StringBuffer();
int depth = 0;
public void addNode(Object key, HashTree subTree) {
depth++;
string.append("\n" + getSpaces() + key + " {");
}
public void subtractNode() {
string.append("\n" + getSpaces() + "}");
depth--;
}
public void processPath() {
}
public String toString() {
string.append("\n}");
return string.toString();
}
private String getSpaces() {
if (spaces.length() < depth * 2) {
while (spaces.length() < depth * 2) {
spaces.append(" ");
}
} else if (spaces.length() > depth * 2) {
spaces.setLength(depth * 2);
}
return spaces.toString();
}
}
}
The table below shows all metrics for HashTree.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 112.00 | Number of blocks | |
| BLOCK_COMMENT | 33.00 | Number of block comment lines | |
| COMMENTS | 592.00 | Comment lines | |
| COMMENT_DENSITY | 2.11 | Comment density | |
| COMPARISONS | 37.00 | Number of comparison operators | |
| CYCLOMATIC | 111.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 67.00 | Comments in declarations | |
| DOC_COMMENT | 516.00 | Number of javadoc comment lines | |
| ELOC | 281.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 62.00 | Procedure exits | |
| FUNCTIONS | 76.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 74.53 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 170.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 1.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 8.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 14.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 2.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 26.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 1.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 1.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 1.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 8.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 2.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 1073.00 | Number of lines in the source file | |
| LINE_COMMENT | 43.00 | Number of line comments | |
| LOC | 392.00 | Lines of code | |
| LOGICAL_LINES | 170.00 | Number of statements | |
| LOOPS | 11.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 854.00 | Number of operands | |
| OPERATORS | 1614.00 | Number of operators | |
| PARAMS | 78.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2468.00 | Halstead program length | |
| PROGRAM_VOCAB | 323.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 92.00 | Number of return points from functions | |
| SIZE | 34759.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 275.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 89.00 | Number of whitespace lines | |