SAXWriter.java
| Index Score | ||
|---|---|---|
 |
 |
org.dom4j.io |
 |
 |
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 |  |
| RETURNS | Number of return points from functions | |
| DECL_COMMENTS | Comments in declarations | |
| COMMENTS | Comment lines | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| FUNCTIONS | Number of function declarations | |
| PARAMS | Number of formal parameter declarations | |
| BLOCKS | Number of blocks | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOC | Lines of code | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0132 | JAVA0132 Method overload with compatible signature | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| OPERANDS | Number of operands | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| UNIQUE_OPERATORS | Number of unique operators | |
| WHITESPACE | Number of whitespace lines | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LINE_COMMENT | Number of line comments | |
| NEST_DEPTH | Maximum nesting depth | |
| 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.io;
import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.dom4j.Attribute;
import org.dom4j.Branch;
import org.dom4j.CDATA;
import org.dom4j.CharacterData;
import org.dom4j.Comment;
import org.dom4j.Document;
import org.dom4j.DocumentType;
import org.dom4j.Element;
import org.dom4j.Entity;
import org.dom4j.Namespace;
import org.dom4j.Node;
import org.dom4j.ProcessingInstruction;
import org.dom4j.Text;
import org.dom4j.tree.NamespaceStack;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.DTDHandler;
import org.xml.sax.EntityResolver;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.XMLReader;
import org.xml.sax.ext.LexicalHandler;
import org.xml.sax.helpers.AttributesImpl;
import org.xml.sax.helpers.LocatorImpl;
/**
* <p>
* <code>SAXWriter</code> writes a DOM4J tree to a SAX ContentHandler.
* </p>
*
* @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
* @version $Revision: 1.24 $
*/
public class SAXWriter implements XMLReader {
protected static final String[] LEXICAL_HANDLER_NAMES = {
"http://xml.org/sax/properties/lexical-handler",
"http://xml.org/sax/handlers/LexicalHandler" };
protected static final String FEATURE_NAMESPACE_PREFIXES
= "http://xml.org/sax/features/namespace-prefixes";
protected static final String FEATURE_NAMESPACES
= "http://xml.org/sax/features/namespaces";
/** <code>ContentHandler</code> to which SAX events are raised */
private ContentHandler contentHandler;
/** <code>DTDHandler</code> fired when a document has a DTD */
private DTDHandler dtdHandler;
/** <code>EntityResolver</code> fired when a document has a DTD */
private EntityResolver entityResolver;
private ErrorHandler errorHandler;
/** <code>LexicalHandler</code> fired on Entity and CDATA sections */
private LexicalHandler lexicalHandler;
/** <code>AttributesImpl</code> used when generating the Attributes */
private AttributesImpl attributes = new AttributesImpl();
/** Stores the features */
private Map features = new HashMap();
/** Stores the properties */
private Map properties = new HashMap();
/** Whether namespace declarations are exported as attributes or not */
private boolean declareNamespaceAttributes;
public SAXWriter() {
properties.put(FEATURE_NAMESPACE_PREFIXES, Boolean.FALSE);
properties.put(FEATURE_NAMESPACE_PREFIXES, Boolean.TRUE);
}
public SAXWriter(ContentHandler contentHandler) {
this();
this.contentHandler = contentHandler;
}
public SAXWriter(ContentHandler contentHandler,
LexicalHandler lexicalHandler) {
this();
this.contentHandler = contentHandler;
this.lexicalHandler = lexicalHandler;
}
public SAXWriter(ContentHandler contentHandler,
LexicalHandler lexicalHandler, EntityResolver entityResolver) {
this();
this.contentHandler = contentHandler;
this.lexicalHandler = lexicalHandler;
this.entityResolver = entityResolver;
}
/**
* A polymorphic method to write any Node to this SAX stream
*
* @param node
* DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
*/
public void write(Node node) throws SAXException {
int nodeType = node.getNodeType();
switch (nodeType) {
case Node.ELEMENT_NODE:
write((Element) node);
break;
case Node.ATTRIBUTE_NODE:
write((Attribute) node);
break;
case Node.TEXT_NODE:
write(node.getText());
break;
case Node.CDATA_SECTION_NODE:
write((CDATA) node);
break;
case Node.ENTITY_REFERENCE_NODE:
write((Entity) node);
break;
case Node.PROCESSING_INSTRUCTION_NODE:
write((ProcessingInstruction) node);
break;
case Node.COMMENT_NODE:
write((Comment) node);
break;
case Node.DOCUMENT_NODE:
write((Document) node);
break;
case Node.DOCUMENT_TYPE_NODE:
write((DocumentType) node);
break;
case Node.NAMESPACE_NODE:
// Will be output with attributes
// write((Namespace) node);
break;
default:
throw new SAXException("Invalid node type: " + node);
}
}
/**
* Generates SAX events for the given Document and all its content
*
* @param document
* is the Document to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(Document document) throws SAXException {
if (document != null) {
checkForNullHandlers();
documentLocator(document);
startDocument();
entityResolver(document);
dtdHandler(document);
writeContent(document, new NamespaceStack());
endDocument();
}
}
/**
* Generates SAX events for the given Element and all its content
*
* @param element
* is the Element to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(Element element) throws SAXException {
write(element, new NamespaceStack());
}
/**
* <p>
* Writes the opening tag of an {@link Element}, including its {@link
* Attribute}s but without its content.
* </p>
*
* @param element
* <code>Element</code> to output.
*
* @throws SAXException
* DOCUMENT ME!
*/
public void writeOpen(Element element) throws SAXException {
startElement(element, null);
}
/**
* <p>
* Writes the closing tag of an {@link Element}
* </p>
*
* @param element
* <code>Element</code> to output.
*
* @throws SAXException
* DOCUMENT ME!
*/
public void writeClose(Element element) throws SAXException {
endElement(element);
}
/**
* Generates SAX events for the given text
*
* @param text
* is the text to send to the SAX ContentHandler
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(String text) throws SAXException {
if (text != null) {
char[] chars = text.toCharArray();
contentHandler.characters(chars, 0, chars.length);
}
}
/**
* Generates SAX events for the given CDATA
*
* @param cdata
* is the CDATA to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(CDATA cdata) throws SAXException {
String text = cdata.getText();
if (lexicalHandler != null) {
lexicalHandler.startCDATA();
write(text);
lexicalHandler.endCDATA();
} else {
write(text);
}
}
/**
* Generates SAX events for the given Comment
*
* @param comment
* is the Comment to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(Comment comment) throws SAXException {
if (lexicalHandler != null) {
String text = comment.getText();
char[] chars = text.toCharArray();
lexicalHandler.comment(chars, 0, chars.length);
}
}
/**
* Generates SAX events for the given Entity
*
* @param entity
* is the Entity to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(Entity entity) throws SAXException {
String text = entity.getText();
if (lexicalHandler != null) {
String name = entity.getName();
lexicalHandler.startEntity(name);
write(text);
lexicalHandler.endEntity(name);
} else {
write(text);
}
}
/**
* Generates SAX events for the given ProcessingInstruction
*
* @param pi
* is the ProcessingInstruction to parse
*
* @throws SAXException
* if there is a SAX error processing the events
*/
public void write(ProcessingInstruction pi) throws SAXException {
String target = pi.getTarget();
String text = pi.getText();
contentHandler.processingInstruction(target, text);
}
/**
* Should namespace declarations be converted to "xmlns" attributes. This
* property defaults to <code>false</code> as per the SAX specification.
* This property is set via the SAX feature
* "http://xml.org/sax/features/namespace-prefixes"
*
* @return DOCUMENT ME!
*/
public boolean isDeclareNamespaceAttributes() {
return declareNamespaceAttributes;
}
/**
* Sets whether namespace declarations should be exported as "xmlns"
* attributes or not. This property is set from the SAX feature
* "http://xml.org/sax/features/namespace-prefixes"
*
* @param declareNamespaceAttrs
* DOCUMENT ME!
*/
public void setDeclareNamespaceAttributes(boolean declareNamespaceAttrs) {
this.declareNamespaceAttributes = declareNamespaceAttrs;
}
// XMLReader methods
// -------------------------------------------------------------------------
/**
* DOCUMENT ME!
*
* @return the <code>ContentHandler</code> called when SAX events are
* raised
*/
public ContentHandler getContentHandler() {
return contentHandler;
}
/**
* Sets the <code>ContentHandler</code> called when SAX events are raised
*
* @param contentHandler
* is the <code>ContentHandler</code> called when SAX events
* are raised
*/
public void setContentHandler(ContentHandler contentHandler) {
this.contentHandler = contentHandler;
}
/**
* DOCUMENT ME!
*
* @return the <code>DTDHandler</code>
*/
public DTDHandler getDTDHandler() {
return dtdHandler;
}
/**
* Sets the <code>DTDHandler</code>.
*
* @param handler
* DOCUMENT ME!
*/
public void setDTDHandler(DTDHandler handler) {
this.dtdHandler = handler;
}
/**
* DOCUMENT ME!
*
* @return the <code>ErrorHandler</code>
*/
public ErrorHandler getErrorHandler() {
return errorHandler;
}
/**
* Sets the <code>ErrorHandler</code>.
*
* @param errorHandler
* DOCUMENT ME!
*/
public void setErrorHandler(ErrorHandler errorHandler) {
this.errorHandler = errorHandler;
}
/**
* DOCUMENT ME!
*
* @return the <code>EntityResolver</code> used when a Document contains a
* DTD
*/
public EntityResolver getEntityResolver() {
return entityResolver;
}
/**
* Sets the <code>EntityResolver</code>.
*
* @param entityResolver
* is the <code>EntityResolver</code>
*/
public void setEntityResolver(EntityResolver entityResolver) {
this.entityResolver = entityResolver;
}
/**
* DOCUMENT ME!
*
* @return the <code>LexicalHandler</code> used when a Document contains a
* DTD
*/
public LexicalHandler getLexicalHandler() {
return lexicalHandler;
}
/**
* Sets the <code>LexicalHandler</code>.
*
* @param lexicalHandler
* is the <code>LexicalHandler</code>
*/
public void setLexicalHandler(LexicalHandler lexicalHandler) {
this.lexicalHandler = lexicalHandler;
}
/**
* Sets the <code>XMLReader</code> used to write SAX events to
*
* @param xmlReader
* is the <code>XMLReader</code>
*/
public void setXMLReader(XMLReader xmlReader) {
setContentHandler(xmlReader.getContentHandler());
setDTDHandler(xmlReader.getDTDHandler());
setEntityResolver(xmlReader.getEntityResolver());
setErrorHandler(xmlReader.getErrorHandler());
}
/**
* Looks up the value of a feature.
*
* @param name
* DOCUMENT ME!
*
* @return DOCUMENT ME!
*
* @throws SAXNotRecognizedException
* DOCUMENT ME!
* @throws SAXNotSupportedException
* DOCUMENT ME!
*/
public boolean getFeature(String name) throws SAXNotRecognizedException,
SAXNotSupportedException {
Boolean answer = (Boolean) features.get(name);
return (answer != null) && answer.booleanValue();
}
/**
* This implementation does actually use any features but just stores them
* for later retrieval
*
* @param name
* DOCUMENT ME!
* @param value
* DOCUMENT ME!
*
* @throws SAXNotRecognizedException
* DOCUMENT ME!
* @throws SAXNotSupportedException
* DOCUMENT ME!
*/
public void setFeature(String name, boolean value)
throws SAXNotRecognizedException, SAXNotSupportedException {
if (FEATURE_NAMESPACE_PREFIXES.equals(name)) {
setDeclareNamespaceAttributes(value);
} else if (FEATURE_NAMESPACE_PREFIXES.equals(name)) {
if (!value) {
String msg = "Namespace feature is always supported in dom4j";
throw new SAXNotSupportedException(msg);
}
}
features.put(name, (value) ? Boolean.TRUE : Boolean.FALSE);
}
/**
* Sets the given SAX property
*
* @param name
* DOCUMENT ME!
* @param value
* DOCUMENT ME!
*/
public void setProperty(String name, Object value) {
for (int i = 0; i < LEXICAL_HANDLER_NAMES.length; i++) {
if (LEXICAL_HANDLER_NAMES[i].equals(name)) {
setLexicalHandler((LexicalHandler) value);
return;
}
}
properties.put(name, value);
}
/**
* Gets the given SAX property
*
* @param name
* DOCUMENT ME!
*
* @return DOCUMENT ME!
*
* @throws SAXNotRecognizedException
* DOCUMENT ME!
* @throws SAXNotSupportedException
* DOCUMENT ME!
*/
public Object getProperty(String name) throws SAXNotRecognizedException,
SAXNotSupportedException {
for (int i = 0; i < LEXICAL_HANDLER_NAMES.length; i++) {
if (LEXICAL_HANDLER_NAMES[i].equals(name)) {
return getLexicalHandler();
}
}
return properties.get(name);
}
/**
* This method is not supported.
*
* @param systemId
* DOCUMENT ME!
*
* @throws SAXNotSupportedException
* DOCUMENT ME!
*/
public void parse(String systemId) throws SAXNotSupportedException {
throw new SAXNotSupportedException("This XMLReader can only accept"
+ " <dom4j> InputSource objects");
}
/**
* Parses an XML document. This method can only accept DocumentInputSource
* inputs otherwise a {@link SAXNotSupportedException}exception is thrown.
*
* @param input
* DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
* @throws SAXNotSupportedException
* if the input source is not wrapping a dom4j document
*/
public void parse(InputSource input) throws SAXException {
if (input instanceof DocumentInputSource) {
DocumentInputSource documentInput = (DocumentInputSource) input;
Document document = documentInput.getDocument();
write(document);
} else {
throw new SAXNotSupportedException(
"This XMLReader can only accept "
+ "<dom4j> InputSource objects");
}
}
// Implementation methods
// -------------------------------------------------------------------------
protected void writeContent(Branch branch, NamespaceStack namespaceStack)
throws SAXException {
for (Iterator iter = branch.nodeIterator(); iter.hasNext();) {
Object object = iter.next();
if (object instanceof Element) {
write((Element) object, namespaceStack);
} else if (object instanceof CharacterData) {
if (object instanceof Text) {
Text text = (Text) object;
write(text.getText());
} else if (object instanceof CDATA) {
write((CDATA) object);
} else if (object instanceof Comment) {
write((Comment) object);
} else {
throw new SAXException("Invalid Node in DOM4J content: "
+ object + " of type: " + object.getClass());
}
} else if (object instanceof String) {
write((String) object);
} else if (object instanceof Entity) {
write((Entity) object);
} else if (object instanceof ProcessingInstruction) {
write((ProcessingInstruction) object);
} else if (object instanceof Namespace) {
write((Namespace) object);
} else {
throw new SAXException("Invalid Node in DOM4J content: "
+ object);
}
}
}
/**
* The {@link org.xml.sax.Locator}is only really useful when parsing a
* textual document as its main purpose is to identify the line and column
* number. Since we are processing an in memory tree which will probably
* have its line number information removed, we'll just use -1 for the line
* and column numbers.
*
* @param document
* DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
*/
protected void documentLocator(Document document) throws SAXException {
LocatorImpl locator = new LocatorImpl();
String publicID = null;
String systemID = null;
DocumentType docType = document.getDocType();
if (docType != null) {
publicID = docType.getPublicID();
systemID = docType.getSystemID();
}
if (publicID != null) {
locator.setPublicId(publicID);
}
if (systemID != null) {
locator.setSystemId(systemID);
}
locator.setLineNumber(-1);
locator.setColumnNumber(-1);
contentHandler.setDocumentLocator(locator);
}
protected void entityResolver(Document document) throws SAXException {
if (entityResolver != null) {
DocumentType docType = document.getDocType();
if (docType != null) {
String publicID = docType.getPublicID();
String systemID = docType.getSystemID();
if ((publicID != null) || (systemID != null)) {
try {
entityResolver.resolveEntity(publicID, systemID);
} catch (IOException e) {
throw new SAXException("Could not resolve publicID: "
+ publicID + " systemID: " + systemID, e);
}
}
}
}
}
/**
* We do not yet support DTD or XML Schemas so this method does nothing
* right now.
*
* @param document
* DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
*/
protected void dtdHandler(Document document) throws SAXException {
}
protected void startDocument() throws SAXException {
contentHandler.startDocument();
}
protected void endDocument() throws SAXException {
contentHandler.endDocument();
}
protected void write(Element element, NamespaceStack namespaceStack)
throws SAXException {
int stackSize = namespaceStack.size();
AttributesImpl namespaceAttributes = startPrefixMapping(element,
namespaceStack);
startElement(element, namespaceAttributes);
writeContent(element, namespaceStack);
endElement(element);
endPrefixMapping(namespaceStack, stackSize);
}
/**
* Fires a SAX startPrefixMapping event for all the namespaceStack which
* have just come into scope
*
* @param element
* DOCUMENT ME!
* @param namespaceStack
* DOCUMENT ME!
*
* @return DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
*/
protected AttributesImpl startPrefixMapping(Element element,
NamespaceStack namespaceStack) throws SAXException {
AttributesImpl namespaceAttributes = null;
// start with the namespace of the element
Namespace elementNamespace = element.getNamespace();
if ((elementNamespace != null)
&& !isIgnoreableNamespace(elementNamespace, namespaceStack)) {
namespaceStack.push(elementNamespace);
contentHandler.startPrefixMapping(elementNamespace.getPrefix(),
elementNamespace.getURI());
namespaceAttributes = addNamespaceAttribute(namespaceAttributes,
elementNamespace);
}
List declaredNamespaces = element.declaredNamespaces();
for (int i = 0, size = declaredNamespaces.size(); i < size; i++) {
Namespace namespace = (Namespace) declaredNamespaces.get(i);
if (!isIgnoreableNamespace(namespace, namespaceStack)) {
namespaceStack.push(namespace);
contentHandler.startPrefixMapping(namespace.getPrefix(),
namespace.getURI());
namespaceAttributes = addNamespaceAttribute(
namespaceAttributes, namespace);
}
}
return namespaceAttributes;
}
/**
* Fires a SAX endPrefixMapping event for all the namespaceStack which have
* gone out of scope
*
* @param stack
* DOCUMENT ME!
* @param stackSize
* DOCUMENT ME!
*
* @throws SAXException
* DOCUMENT ME!
*/
protected void endPrefixMapping(NamespaceStack stack, int stackSize)
throws SAXException {
while (stack.size() > stackSize) {
Namespace namespace = stack.pop();
if (namespace != null) {
contentHandler.endPrefixMapping(namespace.getPrefix());
}
}
}
protected void startElement(Element element,
AttributesImpl namespaceAttributes) throws SAXException {
contentHandler.startElement(element.getNamespaceURI(), element
.getName(), element.getQualifiedName(), createAttributes(
element, namespaceAttributes));
}
protected void endElement(Element element) throws SAXException {
contentHandler.endElement(element.getNamespaceURI(), element.getName(),
element.getQualifiedName());
}
protected Attributes createAttributes(Element element,
Attributes namespaceAttributes) throws SAXException {
attributes.clear();
if (namespaceAttributes != null) {
attributes.setAttributes(namespaceAttributes);
}
for (Iterator iter = element.attributeIterator(); iter.hasNext();) {
Attribute attribute = (Attribute) iter.next();
attributes.addAttribute(attribute.getNamespaceURI(), attribute
.getName(), attribute.getQualifiedName(), "CDATA",
attribute.getValue());
}
return attributes;
}
/**
* If isDelcareNamespaceAttributes() is enabled then this method will add
* the given namespace declaration to the supplied attributes object,
* creating one if it does not exist.
*
* @param attrs
* DOCUMENT ME!
* @param namespace
* DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
protected AttributesImpl addNamespaceAttribute(AttributesImpl attrs,
Namespace namespace) {
if (declareNamespaceAttributes) {
if (attrs == null) {
attrs = new AttributesImpl();
}
String prefix = namespace.getPrefix();
String qualifiedName = "xmlns";
if ((prefix != null) && (prefix.length() > 0)) {
qualifiedName = "xmlns:" + prefix;
}
String uri = "";
String localName = prefix;
String type = "CDATA";
String value = namespace.getURI();
attrs.addAttribute(uri, localName, qualifiedName, type, value);
}
return attrs;
}
/**
* DOCUMENT ME!
*
* @param namespace
* DOCUMENT ME!
* @param namespaceStack
* DOCUMENT ME!
*
* @return true if the given namespace is an ignorable namespace (such as
* Namespace.NO_NAMESPACE or Namespace.XML_NAMESPACE) or if the
* namespace has already been declared in the current scope
*/
protected boolean isIgnoreableNamespace(Namespace namespace,
NamespaceStack namespaceStack) {
if (namespace.equals(Namespace.NO_NAMESPACE)
|| namespace.equals(Namespace.XML_NAMESPACE)) {
return true;
}
String uri = namespace.getURI();
if ((uri == null) || (uri.length() <= 0)) {
return true;
}
return namespaceStack.contains(namespace);
}
/**
* Ensures non-null content handlers?
*/
protected void checkForNullHandlers() {
}
}
/*
* 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 SAXWriter.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 96.00 | Number of blocks | |
| BLOCK_COMMENT | 42.00 | Number of block comment lines | |
| COMMENTS | 386.00 | Comment lines | |
| COMMENT_DENSITY | 1.10 | Comment density | |
| COMPARISONS | 37.00 | Number of comparison operators | |
| CYCLOMATIC | 108.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 49.00 | Comments in declarations | |
| DOC_COMMENT | 337.00 | Number of javadoc comment lines | |
| ELOC | 352.00 | Effective lines of code | |
| EXEC_COMMENTS | 2.00 | Comments in executable code | |
| EXITS | 92.00 | Procedure exits | |
| FUNCTIONS | 48.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 83.13 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 161.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 | 1.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 | 1.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 | 1.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 | 1.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 | 12.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 | 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 | 6.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 | 3.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 | 1.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 | 0.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 | 2.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 | 945.00 | Number of lines in the source file | |
| LINE_COMMENT | 7.00 | Number of line comments | |
| LOC | 436.00 | Lines of code | |
| LOGICAL_LINES | 218.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 936.00 | Number of operands | |
| OPERATORS | 1730.00 | Number of operators | |
| PARAMS | 51.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2666.00 | Halstead program length | |
| PROGRAM_VOCAB | 358.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 110.00 | Number of return points from functions | |
| SIZE | 29078.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 304.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 54.00 | Number of unique operators | |
| WHITESPACE | 123.00 | Number of whitespace lines | |