Node.java
| Index Score | ||
|---|---|---|
 |
 |
org.dom4j |
 |
|
dom4j |
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 | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| SIZE | Size of the file in bytes | |
| COMMENT_DENSITY | Comment density | |
| LINES | Number of lines in the source file | |
| FUNCTIONS | Number of function declarations | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LINE_COMMENT | Number of line comments | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| LOOPS | Number of loops | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| EXITS | Procedure exits | |
| UNIQUE_OPERATORS | Number of unique operators | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
*
* This software is open source.
* See the bottom of this file for the licence.
*/
package org.dom4j;
import java.io.IOException;
import java.io.Writer;
import java.util.List;
/**
* <p>
* <code>Node</code> defines the polymorphic behavior for all XML nodes in a
* dom4j tree.
* </p>
*
* <p>
* A node can be output as its XML format, can be detached from its position in
* a document and can have XPath expressions evaluated on itself.
* </p>
*
* <p>
* A node may optionally support the parent relationship and may be read only.
* </p>
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan </a>
* @version $Revision: 1.31 $
*
* @see #supportsParent
* @see #isReadOnly
*/
public interface Node extends Cloneable {
// W3C DOM complient node type codes
/** Matches Element nodes */
short ANY_NODE = 0;
/** Matches Element nodes */
short ELEMENT_NODE = 1;
/** Matches elements nodes */
short ATTRIBUTE_NODE = 2;
/** Matches elements nodes */
short TEXT_NODE = 3;
/** Matches elements nodes */
short CDATA_SECTION_NODE = 4;
/** Matches elements nodes */
short ENTITY_REFERENCE_NODE = 5;
/** Matches elements nodes */
// public static final short ENTITY_NODE = 6;
/** Matches ProcessingInstruction */
short PROCESSING_INSTRUCTION_NODE = 7;
/** Matches Comments nodes */
short COMMENT_NODE = 8;
/** Matches Document nodes */
short DOCUMENT_NODE = 9;
/** Matches DocumentType nodes */
short DOCUMENT_TYPE_NODE = 10;
// public static final short DOCUMENT_FRAGMENT_NODE = 11;
// public static final short NOTATION_NODE = 12;
/** Matchs a Namespace Node - NOTE this differs from DOM */
// XXXX: ????
short NAMESPACE_NODE = 13;
/** Does not match any valid node */
short UNKNOWN_NODE = 14;
/** The maximum number of node types for sizing purposes */
short MAX_NODE_TYPE = 14;
/**
* <p>
* <code>supportsParent</code> returns true if this node supports the
* parent relationship.
* </p>
*
* <p>
* Some XML tree implementations are singly linked and only support downward
* navigation through children relationships. The default case is that both
* parent and children relationships are supported though for memory and
* performance reasons the parent relationship may not be supported.
* </p>
*
* @return true if this node supports the parent relationship or false it is
* not supported
*/
boolean supportsParent();
/**
* <p>
* <code>getParent</code> returns the parent <code>Element</code> if
* this node supports the parent relationship or null if it is the root
* element or does not support the parent relationship.
* </p>
*
* <p>
* This method is an optional feature and may not be supported for all
* <code>Node</code> implementations.
* </p>
*
* @return the parent of this node or null if it is the root of the tree or
* the parent relationship is not supported.
*/
Element getParent();
/**
* <p>
* <code>setParent</code> sets the parent relationship of this node if the
* parent relationship is supported or does nothing if the parent
* relationship is not supported.
* </p>
*
* <p>
* This method should only be called from inside an <code>Element</code>
* implementation method and is not intended for general use.
* </p>
*
* @param parent
* is the new parent of this node.
*/
void setParent(Element parent);
/**
* <p>
* <code>getDocument</code> returns the <code>Document</code> that this
* <code>Node</code> is part of if this node supports the parent
* relationship.
* </p>
*
* <p>
* This method is an optional feature and may not be supported for all
* <code>Node</code> implementations.
* </p>
*
* @return the document of this node or null if this feature is not
* supported or the node is not associated with a
* <code>Document</code>
*/
Document getDocument();
/**
* <p>
* <code>setDocument</code> sets the document of this node if the parent
* relationship is supported or does nothing if the parent relationship is
* not supported.
* </p>
*
* <p>
* This method should only be called from inside a <code>Document</code>
* implementation method and is not intended for general use.
* </p>
*
* @param document
* is the new document of this node.
*/
void setDocument(Document document);
/**
* <p>
* <code>isReadOnly</code> returns true if this node is read only and
* cannot be modified. Any attempt to modify a read-only <code>Node</code>
* will result in an <code>UnsupportedOperationException</code> being
* thrown.
* </p>
*
* @return true if this <code>Node</code> is read only and cannot be
* modified otherwise false.
*/
boolean isReadOnly();
/**
* <p>
* <code>hasContent</code> returns true if this node is a Branch (either
* an Element or a Document) and it contains at least one content node such
* as a child Element or Text node.
* </p>
*
* @return true if this <code>Node</code> is a Branch with a nodeCount()
* of one or more.
*/
boolean hasContent();
/**
* <p>
* <code>getName</code> returns the name of this node. This is the XML
* local name of the element, attribute, entity or processing instruction.
* For CDATA and Text nodes this method will return null.
* </p>
*
* @return the XML name of this node
*/
String getName();
/**
* <p>
* Sets the text data of this node or this method will throw an
* <code>UnsupportedOperationException</code> if it is read-only.
* </p>
*
* @param name
* is the new name of this node
*/
void setName(String name);
/**
* <p>
* Returns the text of this node.
* </p>
*
* @return the text for this node.
*/
String getText();
/**
* <p>
* Sets the text data of this node or this method will throw an
* <code>UnsupportedOperationException</code> if it is read-only.
* </p>
*
* @param text
* is the new textual value of this node
*/
void setText(String text);
/**
* Returns the XPath string-value of this node. The behaviour of this method
* is defined in the <a href="http://www.w3.org/TR/xpath">XPath
* specification </a>.
*
* @return the text from all the child Text and Element nodes appended
* together.
*/
String getStringValue();
/**
* <p>
* Returns the XPath expression which will return a node set containing the
* given node such as /a/b/@c. No indexing will be used to restrict the
* path if multiple elements with the same name occur on the path.
* </p>
*
* @return the XPath expression which will return a nodeset containing at
* least this node.
*/
String getPath();
/**
* Returns the relative XPath expression which will return a node set
* containing the given node such as a/b/@c. No indexing will be used to
* restrict the path if multiple elements with the same name occur on the
* path.
*
* @param context
* is the parent context from which the relative path should
* start. If the context is null or the context is not an
* ancestor of this node then the path will be absolute and start
* from the document and so begin with the '/' character.
*
* @return the XPath expression relative to the given context which will
* return a nodeset containing at least this node.
*/
String getPath(Element context);
/**
* <p>
* Returns the XPath expression which will return a nodeset of one node
* which is the current node. This method will use the XPath index operator
* to restrict the path if multiple elements with the same name occur on the
* path.
* </p>
*
* @return the XPath expression which will return a nodeset containing just
* this node.
*/
String getUniquePath();
/**
* <p>
* Returns the relative unique XPath expression from the given context which
* will return a nodeset of one node which is the current node. This method
* will use the XPath index operator to restrict the path if multiple
* elements with the same name occur on the path.
* </p>
*
* @param context
* is the parent context from which the path should start. If the
* context is null or the context is not an ancestor of this node
* then the path will start from the document and so begin with
* the '/' character.
*
* @return the XPath expression relative to the given context which will
* return a nodeset containing just this node.
*/
String getUniquePath(Element context);
/**
* <p>
* <code>asXML</code> returns the textual XML representation of this node.
* </p>
*
* @return the XML representation of this node
*/
String asXML();
/**
* <p>
* <code>write</code> writes this node as the default XML notation for
* this node. If you wish to control the XML output (such as for pretty
* printing, changing the indentation policy etc.) then please use {@link
* org.dom4j.io.XMLWriter} or its derivations.
* </p>
*
* @param writer
* is the <code>Writer</code> to output the XML to
*
* @throws IOException
* DOCUMENT ME!
*/
void write(Writer writer) throws IOException;
/**
* Returns the code according to the type of node. This makes processing
* nodes polymorphically much easier as the switch statement can be used
* instead of multiple if (instanceof) statements.
*
* @return a W3C DOM complient code for the node type such as ELEMENT_NODE
* or ATTRIBUTE_NODE
*/
short getNodeType();
/**
* DOCUMENT ME!
*
* @return the name of the type of node such as "Document", "Element",
* "Attribute" or "Text"
*/
String getNodeTypeName();
/**
* <p>
* Removes this node from its parent if there is one. If this node is the
* root element of a document then it is removed from the document as well.
* </p>
*
* <p>
* This method is useful if you want to remove a node from its source
* document and add it to another document. For example
* </p>
* <code> Node node = ...; Element someOtherElement = ...;
* someOtherElement.add( node.detach() ); </code>
*
* @return the node that has been removed from its parent node if any and
* its document if any.
*/
Node detach();
/**
* <p>
* <code>selectNodes</code> evaluates an XPath expression and returns the
* result as a <code>List</code> of <code>Node</code> instances or
* <code>String</code> instances depending on the XPath expression.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return the list of <code>Node</code> or <code>String</code>
* instances depending on the XPath expression
*/
List selectNodes(String xpathExpression);
/**
* <p>
* <code>selectObject</code> evaluates an XPath expression and returns the
* result as an {@link Object}. The object returned can either be a {@link
* List} of one or more {@link Node}instances or a scalar object like a
* {@link String}or a {@link Number}instance depending on the XPath
* expression.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return the value of the XPath expression as a {@link List}of {@link
* Node} instances, a {@link String}or a {@link Number}instance
* depending on the XPath expression.
*/
Object selectObject(String xpathExpression);
/**
* <p>
* <code>selectNodes</code> evaluates an XPath expression then sorts the
* results using a secondary XPath expression Returns a sorted
* <code>List</code> of <code>Node</code> instances.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
* @param comparisonXPathExpression
* is the XPath expression used to compare the results by for
* sorting
*
* @return the list of <code>Node</code> instances sorted by the
* comparisonXPathExpression
*/
List selectNodes(String xpathExpression, String comparisonXPathExpression);
/**
* <p>
* <code>selectNodes</code> evaluates an XPath expression then sorts the
* results using a secondary XPath expression Returns a sorted
* <code>List</code> of <code>Node</code> instances.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
* @param comparisonXPathExpression
* is the XPath expression used to compare the results by for
* sorting
* @param removeDuplicates
* if this parameter is true then duplicate values (using the
* comparisonXPathExpression) are removed from the result List.
*
* @return the list of <code>Node</code> instances sorted by the
* comparisonXPathExpression
*/
List selectNodes(String xpathExpression, String comparisonXPathExpression,
boolean removeDuplicates);
/**
* <p>
* <code>selectSingleNode</code> evaluates an XPath expression and returns
* the result as a single <code>Node</code> instance.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return the <code>Node</code> matching the XPath expression
*/
Node selectSingleNode(String xpathExpression);
/**
* <p>
* <code>valueOf</code> evaluates an XPath expression and returns the
* textual representation of the results the XPath string-value of this
* node. The string-value for a given node type is defined in the <a
* href="http://www.w3.org/TR/xpath">XPath specification </a>.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return the string-value representation of the results of the XPath
* expression
*/
String valueOf(String xpathExpression);
/**
* <p>
* <code>numberValueOf</code> evaluates an XPath expression and returns
* the numeric value of the XPath expression if the XPath expression results
* in a number, or null if the result is not a number.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return the numeric result of the XPath expression or null if the result
* is not a number.
*/
Number numberValueOf(String xpathExpression);
/**
* <p>
* <code>matches</code> returns true if evaluating the given XPath
* expression on this node returns a non-empty node set containing this
* node.
* </p>
*
* <p>
* This method does not behave like the <xsl:if> element - if you want
* that behaviour, to evaluate if an XPath expression matches something,
* then you can use the following code to be equivalent...
* </p>
* <code>if ( node.selectSingleNode( "/some/path" ) != nulll )</code>
*
* @param xpathExpression
* is an XPath expression
*
* @return true if this node is returned by the given XPath expression
*/
boolean matches(String xpathExpression);
/**
* <p>
* <code>createXPath</code> creates an XPath object for the given
* xpathExpression. The XPath object allows the variable context to be
* specified.
* </p>
*
* @param xpathExpression
* is the XPath expression to be evaluated
*
* @return an XPath object represeting the given expression
*
* @throws InvalidXPathException
* if the XPath expression is invalid
*/
XPath createXPath(String xpathExpression) throws InvalidXPathException;
/**
* <p>
* <code>asXPathResult</code> returns a version of this node which is
* capable of being an XPath result. The result of an XPath expression
* should always support the parent relationship, whether the original XML
* tree was singly or doubly linked. If the node does not support the parent
* relationship then a new node will be created which is linked to its
* parent and returned.
* </p>
*
* @param parent
* DOCUMENT ME!
*
* @return a <code>Node</code> which supports the parent relationship
*/
Node asXPathResult(Element parent);
/**
* <p>
* <code>accept</code> is the method used in the Visitor Pattern.
* </p>
*
* @param visitor
* is the visitor in the Visitor Pattern
*/
void accept(Visitor visitor);
/**
* <p>
* <code>clone</code> will return a deep clone or if this node is
* read-only then clone will return the same instance.
* </p>
*
* @return a deep clone of myself or myself if I am read only.
*/
Object clone();
}
/*
* Redistribution and use of this software and associated documentation
* ("Software"), with or without modification, are permitted provided that the
* following conditions are met:
*
* 1. Redistributions of source code must retain copyright statements and
* notices. Redistributions must also contain a copy of this document.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The name "DOM4J" must not be used to endorse or promote products derived
* from this Software without prior written permission of MetaStuff, Ltd. For
* written permission, please contact dom4j-info@metastuff.com.
*
* 4. Products derived from this Software may not be called "DOM4J" nor may
* "DOM4J" appear in their names without prior written permission of MetaStuff,
* Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
*
* 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
*
* THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
*/
The table below shows all metrics for Node.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 42.00 | Number of block comment lines | |
| COMMENTS | 493.00 | Comment lines | |
| COMMENT_DENSITY | 9.48 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 33.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 54.00 | Comments in declarations | |
| DOC_COMMENT | 446.00 | Number of javadoc comment lines | |
| ELOC | 52.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 33.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 11.88 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 21.00 | Interface complexity | |
| JAVA0001 | 1.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 | 0.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.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 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 1.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.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 | 0.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 | 0.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 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.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 | 0.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 | 0.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 | 599.00 | Number of lines in the source file | |
| LINE_COMMENT | 5.00 | Number of line comments | |
| LOC | 53.00 | Lines of code | |
| LOGICAL_LINES | 50.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 137.00 | Number of operands | |
| OPERATORS | 175.00 | Number of operators | |
| PARAMS | 21.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 312.00 | Halstead program length | |
| PROGRAM_VOCAB | 115.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 20045.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 98.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 17.00 | Number of unique operators | |
| WHITESPACE | 53.00 | Number of whitespace lines | |