CleanXmlHelper.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.core.util |
 |
 |
Pentaho |
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 | |
|---|---|---|
| COMMENTS | Comment lines |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0255 | JAVA0255 Result of method invocation not used | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| PARAMS | Number of formal parameter declarations | |
| DECL_COMMENTS | Comments in declarations | |
| EXEC_COMMENTS | Comments in executable code | |
| RETURNS | Number of return points from functions | |
| LOOPS | Number of loops | |
| LOGICAL_LINES | Number of statements | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| OPERANDS | Number of operands | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| BLOCKS | Number of blocks | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| LOC | Lines of code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| BLOCK_COMMENT | Number of block comment lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright 2007 Pentaho Corporation. All rights reserved.
* This software was developed by Pentaho Corporation and is provided under the terms
* of the Mozilla Public License, Version 1.1, or any later version. You may not use
* this file except in compliance with the license. If you need a copy of the license,
* please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
* BI Platform. The Initial Developer is Pentaho Corporation.
*
* Software distributed under the Mozilla Public License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
* the license for the specific language governing your rights and limitations.
*/
package org.pentaho.core.util;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.URIResolver;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;
import org.pentaho.messages.Messages;
import org.xml.sax.EntityResolver;
// TODO sbarkdull, exernalize strings, comment methods
/**
* A set of static methods to help in with: * the construction of XML DOM
* Documents (org.dom4j.Document) from files, streams, and Strings * in the
* creation of XML DOM Documents as the result of an XSLT transform * persisting
* of XML DOM documents to the file system or a <code>Writer</code>. * the
* encoding of a String of Xml text
*
* Design notes: This class should never have any dependencies (i.e. imports) on
* anything on org.pentaho or com.pentaho or their decendant packages. In
* general, methods in the class should not attempt to handle exceptions, but
* should let the exceptions propogate to the caller to be handled there. Please
* do not use european-reuse in this class. One of the primary design goals for
* this class was to construct it in a way that it could be used without change
* outside of the Pentaho platform. Related XML-helper type code that is
* dependant on the platform should be moved "up" to XmlHelper.
*/
public class CleanXmlHelper {
private static final Log logger = LogFactory.getLog(CleanXmlHelper.class);
/*
* this regular expression pattern should match the value of the encoding
* pseudo-attribute in the xml processing instruction in an xml document. e.g.
* <?xml version="1.0" encoding="UTF-8" ?>
*/
private static final Pattern RE_ENCODING = Pattern.compile(
"<\\?xml.*encoding=('|\")([^'\"]*)\\1.*\\?>.*", Pattern.DOTALL); //$NON-NLS-1$
/**
* Should never be called.
*
*/
protected CleanXmlHelper() {
}
/**
* Create a <code>Document</code> from <code>str</code>.
*
* @param str
* String containing the XML that will be used to create the Document
* @param encoding
* String specifying the character encoding. The encoding of the xml
* String can be discovered by calling CleanXmlHelper.getEncoding().
* @param resolver EntityResolver an instance of an EntityResolver that will resolve
* any external URIs. See the docs on EntityResolver. null is an acceptable value.
* @return <code>Document</code> initialized with the xml in
* <code>strXml</code>.
* @throws DocumentException
*/
public static Document getDocFromString(String strXml, String encoding, EntityResolver resolver)
throws DocumentException {
byte[] bytes = null;
Document document = null;
InputStream inStrm = null;
try {
if ( null != encoding )
{
bytes = strXml.getBytes(encoding);
}
else
{
// doh, we don't know the encoding, cross your fingers and hope for the best
bytes = strXml.getBytes();
}
inStrm = new ByteArrayInputStream( bytes );
document = getDocFromStream(inStrm, encoding, resolver);
} catch (UnsupportedEncodingException e) {
if (logger.isErrorEnabled()) {
logger.error(e);
}
} finally {
closeInputStream(inStrm);
}
return document;
}
/**
* Create a <code>Document</code> from <code>str</code>.
*
* @param str
* String containing the XML that will be used to create the Document
* can be discovered by calling CleanXmlHelper.getEncoding().
* @param resolver EntityResolver an instance of an EntityResolver that will resolve
* any external URIs. See the docs on EntityResolver. null is an acceptable value.
*
* @return <code>Document</code> initialized with the xml in
* <code>strXml</code>.
* @throws DocumentException
*/
public static Document getDocFromString(String strXml, EntityResolver resolver) throws DocumentException {
String encoding = getEncoding(strXml);
return getDocFromString(strXml, encoding, resolver);
}
/**
* Create a <code>Document</code> from the contents of a file.
*
* @param path
* String containing the path to the file containing XML that will be
* used to create the Document.
* @param resolver EntityResolver an instance of an EntityResolver that will resolve
* any external URIs. See the docs on EntityResolver. null is an acceptable value.
* @return <code>Document</code> initialized with the xml in
* <code>strXml</code>.
* @throws DocumentException
* if the document isn't valid
* @throws IOException
*/
public static Document getDocFromFile(String path, EntityResolver resolver) throws DocumentException, IOException {
File file = new File(path);
return getDocFromFile(file, resolver);
}
/**
* Create a <code>Document</code> from the contents of a file.
*
* @param path
* String containing the path to the file containing XML that will be
* used to create the Document.
* @param resolver EntityResolver an instance of an EntityResolver that will resolve
* any external URIs. See the docs on EntityResolver. null is an acceptable value.
* @return <code>Document</code> initialized with the xml in
* <code>strXml</code>.
* @throws DocumentException
* if the document isn't valid
* @throws IOException
* if the file doesn't exist
*/
public static Document getDocFromFile(File file, EntityResolver resolver) throws DocumentException, IOException {
InputStream fInStrm = null;
Document document = null;
try {
String encoding = getEncoding(file);
fInStrm = new FileInputStream(file);
document = getDocFromStream( fInStrm, encoding, resolver );
} finally {
closeInputStream(fInStrm);
}
return document;
}
/**
* Create a <code>Document</code> from the contents of an input stream,
* where the input stream contains valid XML.
*
* NOTE: the method Document getDocFromStream(InputStream inStream) should
* be preferred over this method since it examines the XML for the encoding
* specified in the processing instruction. This relieves the caller of the
* burden of discovering the encoding, but also assumes that the encoding
* in the XML is specified properly.
*
* @param inStream InputStream
* input stream to read the XML from
* @param encoding String the character encoding of the bytes in <param>inStream</param>. For instance: UTF-8
* Can be null.
* @param resolver EntityResolver an instance of an EntityResolver that will resolve
* any external URIs. See the docs on EntityResolver. null is an acceptable value.
* @return <code>Document</code> initialized with the xml in
* <code>strXml</code>.
* @throws DocumentException
* if the document isn't valid
* @throws FileNotFoundException
* if the file doesn't exist
*/
private static Document getDocFromStream(InputStream inStream, String encoding, EntityResolver resolver) throws DocumentException {
SAXReader rdr = new SAXReader();
if ( null != encoding )
{
rdr.setEncoding( encoding );
}
if (null != resolver) {
rdr.setEntityResolver(resolver);
}
Document document = rdr.read(inStream);
return document;
}
/**
* Create a <code>Document</code> from the contents of an input stream,
* where the input stream contains valid XML.
*
* @param inStream
* @return
* @throws DocumentException
* @throws IOException
*/
public static Document getDocFromStream(InputStream inStream, EntityResolver resolver) throws DocumentException, IOException {
String encoding = getEncoding( inStream );
return getDocFromStream(inStream, encoding, resolver);
}
/**
* Create a <code>Document</code> from the contents of an input stream,
* where the input stream contains valid XML.
*
* @param inStream
* @return
* @throws DocumentException
* @throws IOException
*/
public static Document getDocFromStream(InputStream inStream) throws DocumentException, IOException {
return getDocFromStream(inStream, null);
}
/**
* WARNING: if the <param>inStream</param> instance does not support mark/reset,
* when this method returns, subsequent reads on <param>inStream</param> will be
* 256 bytes into the stream. This may not be the expected behavior. FileInputStreams
* are an example of an InputStream that does not support mark/reset. InputStreams
* that do support mark/reset will be reset to the beginning of the stream
* when this method returns.
*
* @param inStream
* @return
* @throws IOException
*/
private static String readEncodingProcessingInstruction( InputStream inStream ) throws IOException
{
final int BUFF_SZ = 256;
if ( inStream.markSupported() )
{
inStream.mark(BUFF_SZ+1); // BUFF_SZ+1 forces mark to NOT be forgotten
}
byte[] buf = new byte[ BUFF_SZ ];
int totalBytesRead = 0;
int bytesRead;
do {
bytesRead = inStream.read( buf, totalBytesRead, BUFF_SZ-totalBytesRead );
if ( bytesRead == -1 )
{
break;
}
totalBytesRead += bytesRead;
} while ( totalBytesRead < BUFF_SZ );
if ( inStream.markSupported() )
{
inStream.reset();
}
return new String( buf );
}
/**
* Use the transform specified by xslSrc and transform the document specified
* by docSrc, and return the resulting document.
*
* @param xslSrc
* StreamSrc containing the xsl transform
* @param docSrc
* StreamSrc containing the document to be transformed
* @param params
* Map of properties to set on the transform
* @param resolver
* URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform
* @throws TransformerConfigurationException
* if the TransformerFactory fails to create a Transformer.
* @throws TransformerException
* if actual transform fails.
*/
protected static final StringBuffer transformXml(StreamSource xslSrc, StreamSource docSrc, Map params,
URIResolver resolver) throws TransformerConfigurationException, TransformerException {
StringBuffer sb = null;
StringWriter writer = new StringWriter();
TransformerFactory tf = TransformerFactory.newInstance();
if (null != resolver) {
tf.setURIResolver(resolver);
}
// TODO need to look into compiling the XSLs...
Transformer t = tf.newTransformer(xslSrc); // can throw
// TransformerConfigurationException
// Start the transformation
if (params != null) {
Set keys = params.keySet();
Iterator it = keys.iterator();
String key, val;
while (it.hasNext()) {
key = (String) it.next();
val = (String) params.get(key);
if (val != null) {
t.setParameter(key, val);
}
}
}
t.transform(docSrc, new StreamResult(writer)); // can throw
// TransformerException
sb = writer.getBuffer();
return sb;
}
/**
* Use the transform specified by xslSrc and transform the document specified
* by docSrc, and return the resulting document.
*
* @param xslInStream
* InputStream containing the xsl transform
* @param docInStrm
* InputStream containing the document to be transformed
* @param params
* Map of properties to set on the transform
* @param resolver
* URIResolver instance to resolve URI's in the output document.
*
* @return StringBuffer containing the XML results of the transform
* @throws TransformerConfigurationException
* if the TransformerFactory fails to create a Transformer.
* @throws TransformerException
* if actual transform fails.
*/
public static final StringBuffer transformXml(InputStream xslInStream, InputStream docInStrm, Map params,
URIResolver resolver) throws TransformerConfigurationException, TransformerException {
StreamSource xslSrc = new StreamSource(xslInStream);
StreamSource docSrc = new StreamSource(docInStrm);
return transformXml(xslSrc, docSrc, params, resolver);
}
/**
* Convert a W3C Document to a String.
*
* Note: if you are working with a dom4j Document, you can use it's asXml()
* method.
*
* @param doc
* org.w3c.dom.Document to be converted to a String.
* @return String representing the XML document.
*
* @throws TransformerConfigurationException
* If unable to get an instance of a Transformer
* @throws TransformerException
* If the attempt to transform the document fails.
*/
public static final StringBuffer docToString(org.w3c.dom.Document doc) throws TransformerConfigurationException,
TransformerException {
StringBuffer sb = null;
StringWriter writer = new StringWriter();
TransformerFactory tf = TransformerFactory.newInstance();
Transformer t = tf.newTransformer(); // can throw
// TransformerConfigurationException
Source docSrc = new DOMSource(doc);
t.transform(docSrc, new StreamResult(writer)); // can throw
// TransformerException
sb = writer.getBuffer();
return sb;
}
/**
* Find the character encoding specification in the xml String. If it exists,
* return the character encoding. Otherwise, return null.
*
* @param xml
* String containing the xml
* @return String containing the character encoding in the xml processing
* instruction if it exists, else null.
*/
public static String getEncoding(String xml) {
Matcher m = RE_ENCODING.matcher(xml);
boolean bMatches = m.matches();
if (bMatches && (m.groupCount() == 2)) {
return m.group(2);
}
// no encoding found
return null;
}
private static final int BUFF_SIZE = 512;
public static String getEncoding(File f) throws IOException {
char[] cbuf = new char[BUFF_SIZE];
Reader rdr = null;
try {
rdr = new FileReader(f);
rdr.read(cbuf);
} finally {
rdr.close();
}
String strEnc = String.valueOf(cbuf);
return getEncoding(strEnc);
}
public static String getEncoding( InputStream inStream ) throws IOException {
String encodingPI = readEncodingProcessingInstruction( inStream );
return getEncoding( encodingPI );
}
// TODO sbarkdull, this code is duplicated in LocaleHelper
/**
* convert any character in the XML input (<code>rawValue</code>) whose
* code position is greater than or equal to 0x080 to its Numeric Character
* Reference. For a description of Numeric Character References see:
* http://www.w3.org/TR/html4/charset.html#h-5.3.1
*
* @param rawValue
* String containing the XML to be encoded.
* @return String containing the encoded XML
*/
public static String getXmlEncodedString(String rawValue) {
StringBuffer value = new StringBuffer();
for (int n = 0; n < rawValue.length(); n++) {
int charValue = rawValue.charAt(n);
if (charValue >= 0x80) {
value.append("&#x"); //$NON-NLS-1$
value.append(Integer.toString(charValue, 0x10));
value.append(";"); //$NON-NLS-1$
} else {
value.append((char) charValue);
}
}
return value.toString();
}
/**
* Write an XML document to a file using the specified character encoding.
*
* @param doc
* Document to be written
* @param filePath
* path identifying the File that will be the output of the Document
* @param encoding
* String specifying the character encoding. Can be null, in which
* case the default encoding will be used. See
* http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStreamWriter.html
* @throws IOException
* if unable to obtain a FileWriter on the specified file
*/
public static void saveDomToFile(Document doc, String filePath, String encoding) throws IOException {
File file = new File(filePath);
saveDomToFile(doc, file, encoding);
}
/**
* Write an XML document to a file using the specified character encoding.
*
* @param doc
* Document to be written
* @param file
* File that will be the output of the Document
* @param encoding
* String specifying the character encoding. Can be null, in which
* case the default encoding will be used. See
* http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStreamWriter.html
* @throws IOException
* if unable to obtain a FileWriter on the specified file
*/
public static void saveDomToFile(Document doc, File file, String encoding) throws IOException {
Writer fWriter = null;
if (null != encoding) {
fWriter = new OutputStreamWriter(new FileOutputStream(file), encoding);
} else {
fWriter = new OutputStreamWriter(new FileOutputStream(file));
}
saveDomToWriter(doc, fWriter);
}
public static void saveDomToWriter(Document doc, Writer writer) throws IOException {
writer.write(doc.asXML());
}
/**
*
* @param version
* @param encoding
* @return String Xml Processing instruction text with the specified version (usually 1.0)
* and encoding (for instance, UTF-8)
*/
public static String createXmlProcessingInstruction( String version, String encoding )
{
return "<?xml version=\"" + version + "\" encoding=\"" + encoding + "\" ?>"; //$NON-NLS-1$ //$NON-NLS-3$
}
// TODO sbarkdull, move to junit test class
public static void main(String[] args) {
String strXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root><b>first</b><b>second</b></root>"; //$NON-NLS-1$
try {
Document d = CleanXmlHelper.getDocFromString(strXml, null);
String enc = d.getXMLEncoding();
logger.debug( "encoding: " + enc ); //$NON-NLS-1$
} catch (DocumentException e3) {
// TODO Auto-generated catch block
logger.error(null, e3);
}
String defaultEncoding = (new OutputStreamWriter(new ByteArrayOutputStream())).getEncoding();
Charset cs = Charset.defaultCharset();
logger.info( "default Char set: " + cs.name() + " " + defaultEncoding ); //$NON-NLS-1$//$NON-NLS-2$
ByteArrayInputStream s = new ByteArrayInputStream(strXml.getBytes() );
try {
// must be repeatable
for ( int ii=0; ii<5; ++ii )
{
String pi = CleanXmlHelper.readEncodingProcessingInstruction( s );
String encoding = CleanXmlHelper.getEncoding( pi );
logger.debug( "encoding: " + encoding ); //$NON-NLS-1$
}
s.close();
} catch (IOException e2) {
logger.error(null, e2);
}
try {
Document doc = CleanXmlHelper.getDocFromString( strXml, null ); //$NON-NLS-1$
Node n = doc.selectSingleNode( "/root/b[text()='first']" ); //$NON-NLS-1$
logger.debug( n.getText() );
} catch (DocumentException e) {
logger.error(null, e);
System.exit(1);
}
/*
char[] cbuf = new char[ BUFF_SIZE ];
File f = null;
Reader rdr = null;
try
{
f = new File( "C:\\projects\\pentaho1.6\\pentaho-solutions\\system\\pentaho.xml" );
rdr = new FileReader( f );
rdr.read(cbuf);
} catch (FileNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
finally
{
try {
rdr.close();
}catch( Exception ignore){}
}
String strEnc = String.valueOf( cbuf );
//strEnc = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pentaho-system></pentaho-system>";
//strEnc = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n";
String re = ".*";
re = "<\\?xml.*encoding=('|\")([^'\"]*)\\1.*\\?>.*";
boolean b = strEnc.matches( re );
Pattern p = Pattern.compile( re, Pattern.DOTALL );
Matcher m = p.matcher(strEnc);
boolean matches = m.matches();
for ( int ii=0; ii<=m.groupCount(); ++ii )
{
System.out.println( m.group( ii ) );
}
String enc = null;
try {
enc = getEncoding( f );
} catch (IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
*/
String[] xmls = { "", //$NON-NLS-1$
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<pentaho-system></pentaho-system>", //$NON-NLS-1$
"<?xml version=\"1.0\" encoding=\"windows-1252\"?>\n<root></root>", //$NON-NLS-1$
"<?xml encoding=\"UTF-8\" version=\"1.0\"?><root></root>", //$NON-NLS-1$
"<?xml encoding=\"UTF-8\" version='1.0'?><root></root>", //$NON-NLS-1$
"<?xml encoding='UTF-8' version=\"1.0\"?><root></root>", //$NON-NLS-1$
"<?xml encoding='UTF-8' version='1.0'?><root></root>", //$NON-NLS-1$
"<?xml encoding='UTF-8\" version='1.0'?><root></root>", //$NON-NLS-1$
"<?xml version=\"1.0\"?><root></root>", //$NON-NLS-1$
"bart simpson was here", //$NON-NLS-1$
"<root>encoding=bad</root>" //$NON-NLS-1$
};
for (int ii = 0; ii < xmls.length; ++ii) {
String enc = getEncoding(xmls[ii]);
logger.trace("2xml: {0} enc: {1}" + xmls[ii] + " enc: " + enc); //$NON-NLS-1$ //$NON-NLS-2$
enc = ""; //$NON-NLS-1$
}
// performance test
final int numTries = 10000;
// big file
String nm = "C:\\projects\\pentaho\\pentaho-reportwizard\\samples\\data\\ClassicCars.xml"; //$NON-NLS-1$
nm = "C:\\projects\\pentaho1.6\\pentaho-solutions\\system\\pentaho.xml";//$NON-NLS-1$
// small file
// String nm = "C:\\projects\\pentaho\\my-solutions\\index.xml";
String xml = null;
try {
xml = getDocFromFile(nm, null).asXML();
} catch (DocumentException de) {
logger.error(null, de);
} catch (IOException ioe) {
logger.error(null, ioe);
}
// let's run a test to see if getEncoding is reasonably fast
long start0 = System.currentTimeMillis();
for (int ii = 0; ii < numTries; ++ii) {
getEncoding(xml);
}
long end0 = System.currentTimeMillis();
logger.info("time: " + (end0 - start0)); //$NON-NLS-1$
long start1 = System.currentTimeMillis();
for (int ii = 0; ii < numTries; ++ii) {
for (int jj = 0; jj < xml.length(); ++jj) {
xml.charAt(jj);
}
}
long end1 = System.currentTimeMillis();
logger.info("time: " + (end1 - start1)); //$NON-NLS-1$
// end reasonably fast test
}
/**
* Convenience method to close an input stream and handle (log and throw away)
* any exceptions. Helps keep code uncluttered.
*
* @param strm
* InputStream to be closed
*/
protected static void closeInputStream(InputStream strm) {
if (null != strm) {
try {
strm.close();
} catch (IOException e) {
logger.warn(Messages.getString("CleanXmlHelper.WARN_INPUT_STREAM_NOT_CLOSED"), e); //$NON-NLS-1$
}
}
}
}
The table below shows all metrics for CleanXmlHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 65.00 | Number of blocks | |
| BLOCK_COMMENT | 61.00 | Number of block comment lines | |
| COMMENTS | 323.00 | Comment lines | |
| COMMENT_DENSITY | 1.26 | Comment density | |
| COMPARISONS | 23.00 | Number of comparison operators | |
| CYCLOMATIC | 51.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 24.00 | Comments in declarations | |
| DOC_COMMENT | 243.00 | Number of javadoc comment lines | |
| ELOC | 256.00 | Effective lines of code | |
| EXEC_COMMENTS | 15.00 | Comments in executable code | |
| EXITS | 70.00 | Procedure exits | |
| FUNCTIONS | 22.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 62.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 92.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 | 1.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 | 4.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 3.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.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 | 4.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 | 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 | 1.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 | 1.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 | 3.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 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 1.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 | 1.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 | 3.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 | 701.00 | Number of lines in the source file | |
| LINE_COMMENT | 19.00 | Number of line comments | |
| LOC | 318.00 | Lines of code | |
| LOGICAL_LINES | 186.00 | Number of statements | |
| LOOPS | 8.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 820.00 | Number of operands | |
| OPERATORS | 1340.00 | Number of operators | |
| PARAMS | 41.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2160.00 | Halstead program length | |
| PROGRAM_VOCAB | 350.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 51.00 | Number of return points from functions | |
| SIZE | 25788.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 304.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 46.00 | Number of unique operators | |
| WHITESPACE | 60.00 | Number of whitespace lines | |