LdifUtility.java
| Index Score | ||
|---|---|---|
 |
 |
com.ca.commons.naming |
 |
 |
JXplorer |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| JAVA0081 | JAVA0081 Boolean literal in comparison | |
| COMPARISONS | Number of comparison operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0266 | JAVA0266 Use of System.out | |
| LINE_COMMENT | Number of line comments | |
| SIZE | Size of the file in bytes | |
| CYCLOMATIC | Cyclomatic complexity | |
| EXITS | Procedure exits | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| OPERANDS | Number of operands | |
| BLOCKS | Number of blocks | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| ELOC | Effective lines of code | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LOGICAL_LINES | Number of statements | |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0288 | JAVA0288 Inconsistent null check | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
package com.ca.commons.naming;
import javax.naming.*;
import javax.naming.directory.*;
import java.util.*;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.io.*;
import com.ca.commons.cbutil.*;
/**
* collection of static utility ftns. for
* writing and reading ldif files. Currently does not
* handle URLs properly, but will do base64 encoding
* quite happily given half a chance...
*/
//TODO: add 'version 2' handling to ldif file when using xml / ldif, and setup config parameter.
public class LdifUtility
{
private static boolean debug = false;
private static boolean handleXML = false;
private Hashtable params = null; // list of expandable strings for the ldif file, used during file parsing
// e.g. KEY: <base_dn>, KEY VALUE: "o=eTrust, cn=Users"
private String filedir = null;
private String cr = System.getProperty("line.separator", "\n");
private final static Logger log = Logger.getLogger(LdifUtility.class.getName());
public LdifUtility()
{
}
/**
* Sets whether to support the draft rfc for special handling of XML data in LDIF files.
* @param state
*/
public static void setSupportXML_LDIF_RFC(boolean state)
{
handleXML = state;
}
/**
* Constructor
*
* @param params - hashtable with the list of string that will have to be suvstituted in the ldif file
* @param filedir - ldif file directory, used to find the input files specified in the ldif stream
*/
public LdifUtility(Hashtable params, String filedir)
{
this.params = params;
this.filedir = filedir;
}
/**
* Set the ldif filepath - used to find input files
*
* @param filedir file path
*/
public void setFileDir(String filedir)
{
this.filedir = filedir + "\\";
}
/**
* Set the ldif file parameters
*
* @param params list of parameters
*/
public void setParams(Hashtable params)
{
this.params = params;
}
/**
* This is used to write a value that is *probably* normal
* string encoded, but *may* need to be base64 encoded.
* It also takes a boolean parameter that forces base64 encoding.
* Otherwise, it
* checks the string against the requirements of draft-good-ldap-ldif-04
* (initial character sane, subsequent characters not null, CR or LF),
* and returns the appropriate string, with appropriate ': ' or ':: '
* prefix.
*
* @param o the object to be ldif encoded
* @return the ldif encoding (possibly base64) with appropriate colons.
*/
public String ldifEncode(Object o, int offset, boolean forceBase64Encoding)
{
if (forceBase64Encoding == false)
return ldifEncode(o, offset);
String ret = ":: ";
if (o.getClass().isArray())
{
try
{
byte b[] = (byte[]) o;
ret += CBBase64.binaryToString(b, offset + 3);
return ret;
}
catch (ClassCastException e)
{
System.out.println("unable to cast array to byte array.");
}
}
// it's not a byte array; force it to a string, read as bytes,
// and code those. This will work in most cases, but will
// fail badly for isNonString data that has not been encoded properly
// already; e.g. a gif file should (probably) be translated to a
// byte array before being passed to this ftn.
ret += CBBase64.binaryToString(o.toString().getBytes(), offset + 3);
return ret;
}
/**
* This is used to write a value that is *probably* normal
* string encoded, but *may* need to be base64 encoded or xml encoded. It
* checks the string against the requirements of draft-good-ldap-ldif-04
* (initial character sane, subsequent characters not null, CR or LF),
* and returns the appropriate string, with appropriate ': ' or ':: '
* prefix. It also supports the draft 'Extended LDAP Data Interchange Foramt'
* handling of xml text that is identified by an initial '<?xml ' string.
*
* @param o the object to be ldif encoded
* @param offset The first line of the string may be offset by
* by this many characters for nice formatting (e.g. in
* an ldif file, the first line may include 'att value = ...'
* at the beginning of the base 64 encoded block).
* @return the ldif encoding (possibly base64) with appropriate colons.
*/
public String ldifEncode(Object o, int offset)
{
boolean base64Encode = false;
boolean xmlEncode = false;
if ((o instanceof String) == false)
{
if (debug == true) System.out.println("found a " + o.getClass().toString());
if (o.getClass().isArray())
{
try
{
byte b[] = (byte[]) o;
String ret = ":: " + CBBase64.binaryToString(b, offset + 3);
if (debug == true) System.out.println("phenomenal - identified and wrote '" + ret + "'");
return ret;
}
catch (ClassCastException e)
{
if (debug == true) System.out.println("unable to cast array to byte array.");
}
}
return o.toString();
}
else // we have a string
{
String s = o.toString();
int len = s.length();
if (len == 0) return ": "; // this shouldn't really happen; null attributes should be culled before we get here...
// run the rfc tests to see if this is a good and virtuous string
char startChar = s.charAt(0);
if ("\n\r :".indexOf(startChar) != -1) // check for safe start char
base64Encode = true;
else if (startChar == '<')
{
if (handleXML == true && s.startsWith("<?xml ")) // we have xml text, and will cope with wierd characters differently.
xmlEncode = true;
else
base64Encode = true;
}
else
{
char test[] = new char[len];
s.getChars(0, len, test, 0);
for (int i = 0; i < len; i++)
{
//System.out.println("checking: " + i + ": " + test[i] + " = " + CBUtility.charToHex(test[i]));
if (test[i] > 126 || test[i] < 32) // check for sane intermediate chars
{
base64Encode = true; // (may be unicode international string)
break;
}
}
}
if (s.charAt(s.length() - 1) == ' ') // end space considered harmful
base64Encode = true;
if (base64Encode)
{
return translateToLdifBase64(s, offset);
}
else if (xmlEncode)
return translateToLdifXML(s);
else
return ": " + s; // return unmodified string.
}
}
private String translateToLdifBase64(String s, int offset)
{
try
{
s = CBBase64.binaryToString(s.getBytes("UTF8"), offset + 3);
}
catch (UnsupportedEncodingException e) // why would we get this when utf8 is mandatory across all java platforms?
{
log.log(Level.WARNING, "error utf8 encoding strings...", e);
s = CBBase64.binaryToString(s.getBytes(), offset + 3);
}
return ":: " + s;
}
/**
* This replaces new lines (of various sorts) with a 'new line' + '>' character, as per 'xml in ldif' draft rfc.
* @param s
* @return
*/
private String translateToLdifXML(String s)
{
StringBuffer xml = new StringBuffer(";transfer-rxer>:").append(cr).append(s);
// carriage return madness :-(. Runs fastest on systems that use '\n' only. Seems about right.
if (s.indexOf("\r") != -1) // mac (I think)
{
CBParse.replaceAllBufferString(xml, "\r", "\r>");
}
if (s.indexOf("\n") != -1) // catches both '\r\n' and '\n'
{
CBParse.replaceAllBufferString(xml, "\n", "\n>");
}
return xml.toString();
}
/**
* Writes a single ldif entry...
*
*/
/**
* retrieves a single entry from the directory and writes it
* out to an ldif file. Note that ldif header 'version 1' must
* be written elsewhere...
*
* @param dn the ldap escaped dn of the entry being written
* @param saveFile the file to write the entry to
* @param originalPrefix an optional portion of the dn to update
* @param replacementPrefix an optional replacement for a portion of the dn
* @param atts the attributes of teh entry
*/
public void writeLdifEntry(String dn, FileWriter saveFile, String originalPrefix, String replacementPrefix, Attributes atts)
throws NamingException, IOException
{
if (atts == null)
{
log.info("no attributes available for " + dn);
return;
}
/**
* Prefix replacement magic. If we are moving the tree during
* the save, and a different prefix has been given (i.e. the
* originalPrefix and replacementPrefix variables aren't zero)
* we switch the relavent portion of the saved dn, substituting
* the portion of the dn that contains the original prefix with
* the replacement.
* e.g. cn=Fredo,o=FrogFarm,c=au, with original prefix o=FrogFarm,c=au
* and replacement o=FreeFrogs,c=au, becomes cn=Fredo,o=FreeFrogs,c=au
*/
if ((originalPrefix != null) && (dn.endsWith(originalPrefix))) // which it jolly well should...
{
if (debug == true) System.out.println("original DN = '" + dn + "'");
dn = dn.substring(0, dn.length() - originalPrefix.length()) + replacementPrefix;
if (debug == true) System.out.println("after replacement DN = '" + dn + "'");
}
Attribute oc; // we treat the object class attribute
oc = atts.get("oc"); // specially to ensure it is first after the dn.
if (oc != null) // XXX do a name conversion...
{
if (oc instanceof DXAttribute)
((DXAttribute) oc).setName("objectClass");
}
else // (mind you its bloody hard to track down...!)
oc = atts.get("objectclass"); // so keep looking...
if (oc == null)
oc = atts.get("objectClass"); // this really bites.
if (oc == null)
{
if (dn.endsWith("cn=schema")) // XXX el dirty hack to allow schema to be sorta written out...
oc = new BasicAttribute("oc", "schema");
}
if (oc == null)
{
log.info("unable to identify object class for " + dn + " - skipping entry");
return;
}
if (debug)
System.out.println("dn" + ldifEncode(dn, 2));
else
saveFile.write("dn" + ldifEncode(dn, 2) + "\n");
NamingEnumeration ocs = oc.getAll();
while (ocs.hasMore())
{
if (debug)
System.out.println(oc.getID() + ": " + ocs.next());
else
saveFile.write(oc.getID() + ldifEncode(ocs.next(), oc.getID().length()) + "\n");
}
NamingEnumeration allAtts = atts.getAll();
String attName;
Attribute currentAtt;
while (allAtts.hasMore())
{
currentAtt = (Attribute) allAtts.next();
boolean binary = false;
if (currentAtt instanceof DXAttribute)
binary = !((DXAttribute) currentAtt).isString();
attName = currentAtt.getID();
/*
* Make sure we don't print out 'dn' or objectclass attributes twice
*/
if ((attName.equals("dn") == false) && (attName.equals(oc.getID()) == false))
{
NamingEnumeration values = currentAtt.getAll();
while (values.hasMore())
{
Object value = values.next();
if (value != null)
{
//BY THE TIME IT GETS HERE THE UTF-8 IS HISTORY...
if (debug)
{
System.out.println("value class = " + value.getClass().toString() + " : " + value);
System.out.println(attName + ": " + value.toString());
}
else
{
if (binary)
saveFile.write(attName + ldifEncode(value, attName.length(), true) + "\n");
else
saveFile.write(attName + ldifEncode(value, attName.length()) + "\n");
}
}
}
}
}
if (!debug)
{
saveFile.write("\n");
saveFile.flush();
}
}
/**
* Parse an attribute: value line of an ldif file, and place
* the attribute value pair in an Attributes object.
*
* @param parseableLine a complete ldif text line (unwrapped) to parse
* @param newEntry the partially created entry, which is modified by this
* method.
*/
public void ldifDecode(String parseableLine, DXEntry newEntry)
{
boolean isBinary = false;
int breakpos = parseableLine.indexOf(':');
if (breakpos < 0)
{
log.warning("Error - illegal line in ldif file\n" + parseableLine);
return;
}
String attribute = parseableLine.substring(0, breakpos);
Object value = null;
int attLen = attribute.length();
// auto-translate 'oc' to 'objectClass'
if (attribute.equals("oc")) attribute = "objectClass";
int startpos = 2;
if (parseableLine.length() <= breakpos + 1) // empty value
{
value = "";
}
else if (parseableLine.charAt(breakpos + 1) == ':') // check for base64 encoded isNonString
{
value = getBase64Value(parseableLine, attLen, startpos, attribute); // may return string or byte array!
if (value instanceof String == false)
isBinary = true;
}
else
{
if (parseableLine.charAt(attLen + 1) != ' ') // again, may be a leading space, or may not...
startpos = 1;
value = parseableLine.substring(attLen + startpos);
// expand the value parameters, including the urls
value = expandValueParams(value);
}
if ("dn".equalsIgnoreCase(attribute))
{
if (value instanceof String)
{
DN dn = new DN((String) value);
if (dn.error())
log.warning("Error trying to initialise ldif DN: \n" + dn.getError());
else
newEntry.putDN(dn);
}
else // this code should no longer be triggered, as utf8 conversion is done when data first read...
{
try
{
DN dn = new DN(new String((byte[]) value, "UTF8"));
if (dn.error())
log.log(Level.WARNING, "Error trying to initialise ldif DN: \n", dn.getError());
else
newEntry.putDN(dn);
}
catch (UnsupportedEncodingException e)
{
} // can't happen?: UTF8 is mandatory...
}
}
else if (attribute != null)
{
Attribute existing = newEntry.get(attribute);
if (existing == null)
{
DXAttribute att = new DXAttribute(attribute, value);
att.setString(!isBinary);
newEntry.put(att);
}
else
{
existing.add(value);
newEntry.put(existing);
}
}
}
/**
*
*/
private Object getBase64Value(String parseableLine, int attLen, int startpos, String attribute)
{
byte[] rawBinaryData;
if (parseableLine.charAt(attLen + 2) == ' ') // may be ::XXXX or :: XXXX -> so must adjust for possible space
startpos = 3;
rawBinaryData = CBBase64.stringToBinary(parseableLine.substring(attribute.length() + startpos));
// a bit dodgy - we try to guess whether the isNonString data is UTF-8, or is really isNonString...
// we should probably do some schema checking here, but instead we'll try to make an educated
// guess...
// Create a short array to test for utf-8 ishness... (we don't want to test all of large text files)
byte[] testBytes;
if (rawBinaryData.length > 256)
{
testBytes = new byte[256];
System.arraycopy(rawBinaryData, 0, testBytes, 0, 256);
}
else
testBytes = rawBinaryData;
/*
* Make a (slightly ad-hoc) check to see if it is actually a utf-8 string *pretending* to by bytes...
*/
if (CBParse.isUTF8(testBytes))
{
try
{
return new String(rawBinaryData, "UTF-8");
}
catch (Exception e) // as per String constructor doco, behaviour is 'unspecified' if the above fails...
{
// drop through to return the raw isNonString data instead...
}
}
return rawBinaryData;
}
/**
* Read an entry from LDIF text. Attribute/value pairs are read until
* a blank line is encountered.
*
* @param textReader a buffered Reader to read lines of ldif text from...
* @return the read entry, as a DXAttributes object
* @throws InterruptedIOException if the user hits cancel on the progress bar
*/
public DXEntry readLdifEntry(BufferedReader textReader)
throws IOException
{
DXEntry entry = new DXEntry();
// this is the 'look ahead' current line, read from the ldif file.
String line = "";
// this is the first line of the attribute, read from the ldif file.
String firstLine = "";
/* This is a little tricky. Because lines may be extended by line wrapping,
* we need to look ahead a line until we're sure that we've finished any
* possible wrapping, and only then (when we've already read the 'next' line)
* can we process the old line.
*/
// WARNING - this code is a little messy - trying to make it quick since ldif load is slow :-/.
StringBuffer multiLineText = null; //don't use this unless we need it...
while ((line = textReader.readLine()) != null)
{
if (line.length() > 0 && line.charAt(0) == ' ') // line wrap; normal
{
if (multiLineText == null)
multiLineText = new StringBuffer(firstLine);
multiLineText.append(line.substring(1));
//line = firstLine + line.substring(1); // extend the value...
}
else if (line.length() > 0 && line.charAt(0) == '>') // line wrap; XML (as per draft xml/ldif standard)
{
if (multiLineText == null)
multiLineText = new StringBuffer(firstLine);
multiLineText.append(line.substring(1)).append(cr);
//line = firstLine + line.substring(1) + "\n"; // extend the value...
}
else if (firstLine.length() > 1 && firstLine.charAt(0) == '#')
{
// comment... do nothing.
}
else if (firstLine.length() > 2 || multiLineText != null)
{
if (multiLineText != null)
ldifDecode(multiLineText.toString(), entry);
else
ldifDecode(firstLine, entry);
multiLineText = null;
}
if (line == null || line.equals("")) // end of entry...
{
return entry;
}
firstLine = line;
}
if (entry.getDN().size() > 0) // dn check is for unexpectedly truncated files
{
// unusual - end of file reached, and the file *doesn't* have
// a blank line at the end - hence a special case while we write
// the last entry
if (firstLine != null && firstLine.trim().length() > 0)
ldifDecode(firstLine, entry);
return entry; // should be last entry
}
return null; // finished reading everything...
}
/**
* This method expands the strings inside the ldif file
* that match the list of expandable strings in params list.
*
* @param value value to be expanded
* @return expanded object
*/
public Object expandValueParams(Object value)
{
if (params != null)
{
Enumeration keys = params.keys();
while (keys.hasMoreElements())
{
String key = (String) keys.nextElement();
String keyvalue = (String) params.get(key);
// check for the key
String oldValue = (String) value;
int index = oldValue.indexOf(key);
if (index > -1)
{
String newValue = oldValue.substring(0, index) + keyvalue +
oldValue.substring(index + key.length(), oldValue.length());
System.out.println(newValue);
value = newValue;
}
}
}
// load the file if the value is a url
if (filedir != null)
{
// check if it is a file, i.e. look for "< file:"
String oldValue = (String) value;
String match = "< file://";
int index = (oldValue.toLowerCase()).indexOf(match);
if (index > -1)
{
String filename = filedir + oldValue.substring(index + 9, oldValue.length());
File file = new File(filename);
try
{
FileInputStream input = new FileInputStream(file);
int length = (int) file.length();
if (length > 0)
{
byte[] bytes = new byte[length];
int read = input.read(bytes);
if (read > 0) value = bytes;
}
input.close();
}
catch (IOException e)
{
System.out.println("Error opening the file!" + e);
}
}
}
return value;
}
}
The table below shows all metrics for LdifUtility.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 75.00 | Number of blocks | |
| BLOCK_COMMENT | 11.00 | Number of block comment lines | |
| COMMENTS | 152.00 | Comment lines | |
| COMMENT_DENSITY | 0.55 | Comment density | |
| COMPARISONS | 94.00 | Number of comparison operators | |
| CYCLOMATIC | 102.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 16.00 | Comments in declarations | |
| DOC_COMMENT | 111.00 | Number of javadoc comment lines | |
| ELOC | 277.00 | Effective lines of code | |
| EXEC_COMMENTS | 24.00 | Comments in executable code | |
| EXITS | 70.00 | Procedure exits | |
| FUNCTIONS | 14.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 86.11 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 69.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 | 1.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 | 39.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 | 2.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 | 3.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 1.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 | 3.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 | 11.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 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.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 | 3.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.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 | 2.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 | 0.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 | 1.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 5.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 | 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 | 12.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 | 1.00 | JAVA0288 Inconsistent null check | |
| LINES | 671.00 | Number of lines in the source file | |
| LINE_COMMENT | 30.00 | Number of line comments | |
| LOC | 427.00 | Lines of code | |
| LOGICAL_LINES | 167.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 868.00 | Number of operands | |
| OPERATORS | 1683.00 | Number of operators | |
| PARAMS | 26.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2551.00 | Halstead program length | |
| PROGRAM_VOCAB | 302.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 43.00 | Number of return points from functions | |
| SIZE | 23677.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 252.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 92.00 | Number of whitespace lines | |