Base32.java
| Index Score | ||
|---|---|---|
 |
 |
com.bitzi.util |
 |
 |
Phex |
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 |  |
| JAVA0076 | JAVA0076 Use of magic number | |
| LINE_COMMENT | Number of line comments | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| BLOCK_COMMENT | Number of block comment lines | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| UNIQUE_OPERATORS | Number of unique operators | |
| COMMENTS | Comment lines | |
| BLOCKS | Number of blocks | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| EXITS | Procedure exits | |
| WHITESPACE | Number of whitespace lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| FUNCTIONS | Number of function declarations | |
| RETURNS | Number of return points from functions | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOOPS | Number of loops | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/* (PD) 2001 The Bitzi Corporation
* Please see http://bitzi.com/publicdomain for more info.
*
* Base32.java
*/
package com.bitzi.util;
/**
* Base32 - encodes and decodes 'Canonical' Base32 strings.
*
* @author Robert Kaye & Gordon Mohr for original work on Base32
* @author Philippe Verdy for optimizations and canonical checking
*/
public class Base32 {
/* Lookup table used to canonically encode() groups of data bits */
private static final char[] canonicalChars =
{'A','B','C','D','E','F','G','H','I','J','K','L','M' // 00..12
,'N','O','P','Q','R','S','T','U','V','W','X','Y','Z' // 13..25
,'2','3','4','5','6','7' // 26..31
};
/* First valid character that can be indexed in decode lookup table */
private static final int charDigitsBase = (int)'2';
/* Lookup table used to decode() characters in encoded strings */
private static final int[] charDigits =
{ 26,27,28,29,30,31,-1,-1,-1,-1,-1,-1,-1,-1 // 23456789:;<=>?
,-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12,13,14 // @ABCDEFGHIJKLMNO
,15,16,17,18,19,20,21,22,23,24,25,-1,-1,-1,-1,-1 // PQRSTUVWXYZ[\]^_
,-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12,13,14 // `abcdefghijklmno
,15,16,17,18,19,20,21,22,23,24,25 // pqrstuvwxyz
};
/* Messsages for Illegal Parameter Exceptions in decode() */
private static final String errorNonCanonicalLength
= "non canonical Base32-encoded string length";
private static final String errorInvalidChar
= "invalid character in Base32-encoded string";
private static final String errorNonCanonicalEnd
= "non canonical bits at end of Base32-encoded string";
/**
* Encode an array of binary bytes into a Base32 string.
* Should not fail (the only possible exception is that the
* returned string cannot be allocated in memory)
*/
static public String encode(final byte[] bytes) {
int bytesOffset = 0, bytesLen = bytes.length;
int charsOffset = 0, charsLen = ((bytesLen << 3) + 4) / 5;
final char[] chars = new char[charsLen];
while (bytesLen != 0) {
int digit, lastDigit;
// INVARIANTS FOR EACH STEP n in [0..5[; digit in [0..31[;
// The remaining n bits are already aligned on top positions
// of the 5 least bits of digit, the other bits are 0.
////// STEP n = 0: insert new 5 bits, leave 3 bits
digit = bytes[bytesOffset ] & 255;
chars[charsOffset ] = canonicalChars[digit >>> 3];
lastDigit = (digit & 7) << 2;
if (bytesLen == 1) { // put the last 3 bits
chars[charsOffset + 1] = canonicalChars[lastDigit];
break;
}
////// STEP n = 3: insert 2 new bits, then 5 bits, leave 1 bit
digit = bytes[bytesOffset + 1] & 255;
chars[charsOffset + 1] = canonicalChars[(digit >>> 6) | lastDigit];
chars[charsOffset + 2] = canonicalChars[(digit >>> 1) & 31];
lastDigit = (digit & 1) << 4;
if (bytesLen == 2) { // put the last 1 bit
chars[charsOffset + 3] = canonicalChars[lastDigit];
break;
}
////// STEP n = 1: insert 4 new bits, leave 4 bit
digit = bytes[bytesOffset + 2] & 255;
chars[charsOffset + 3] = canonicalChars[(digit >>> 4) | lastDigit];
lastDigit = (digit & 15) << 1;
if (bytesLen == 3) { // put the last 1 bits
chars[charsOffset + 4] = canonicalChars[lastDigit];
break;
}
////// STEP n = 4: insert 1 new bit, then 5 bits, leave 2 bits
digit = bytes[bytesOffset + 3] & 255;
chars[charsOffset + 4] = canonicalChars[(digit >>> 7) | lastDigit];
chars[charsOffset + 5] = canonicalChars[(digit >>> 2) & 31];
lastDigit = (digit & 3) << 3;
if (bytesLen == 4) { // put the last 2 bits
chars[charsOffset + 6] = canonicalChars[lastDigit];
break;
}
////// STEP n = 2: insert 3 new bits, then 5 bits, leave 0 bit
digit = bytes[bytesOffset + 4] & 255;
chars[charsOffset + 6] = canonicalChars[(digit >>> 5) | lastDigit];
chars[charsOffset + 7] = canonicalChars[digit & 31];
//// This point is always reached for bytes.length multiple of 5
bytesOffset += 5;
charsOffset += 8;
bytesLen -= 5;
}
return new String(chars);
}
/**
* Decode a Base32 encoded string into an array of binary bytes.
* May fail if the parameter is a non canonical Base32 string
* (the only other possible exception is that the
* returned array cannot be allocated in memory)
*/
static public byte[] decode(final String encoded)
throws IllegalArgumentException {
final char[] chars = encoded.toCharArray(); // avoids using charAt()
int charsLen = chars.length;
// Note that the code below detects could detect non canonical
// Base32 length within the loop. However canonical Base32 length
// can be tested before entering the loop.
// A canonical Base32 length modulo 8 cannot be:
// 1 (aborts discarding 5 bits at STEP n=0 which produces no byte),
// 3 (aborts discarding 7 bits at STEP n=2 which produces no byte),
// 6 (aborts discarding 6 bits at STEP n=1 which produces no byte).
switch (charsLen & 7) { // test the length of last subblock
case 1: // 5 bits in subblock: 0 useful bits but 5 discarded
case 3: // 15 bits in subblock: 8 useful bits but 7 discarded
case 6: // 30 bits in subblock: 24 useful bits but 6 discarded
throw new IllegalArgumentException(errorNonCanonicalLength);
}
final int charDigitsLen = charDigits.length;
final int bytesLen = (charsLen * 5) >>> 3;
final byte[] bytes = new byte[bytesLen];
int bytesOffset = 0, charsOffset = 0;
// Also the code below does test that other discarded bits
// (1 to 4 bits at end) are effectively 0.
while (charsLen > 0) {
int digit, lastDigit;
// STEP n = 0: Read the 1st Char in a 8-Chars subblock
// Leave 5 bits, asserting there's another encoding Char
if ((digit = (int)chars[charsOffset] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
lastDigit = digit << 3;
// STEP n = 5: Read the 2nd Char in a 8-Chars subblock
// Insert 3 bits, leave 2 bits, possibly trailing if no more Char
if ((digit = (int)chars[charsOffset + 1] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
bytes[bytesOffset] = (byte)((digit >> 2) | lastDigit);
lastDigit = (digit & 3) << 6;
if (charsLen == 2) {
if (lastDigit != 0)
throw new IllegalArgumentException(errorNonCanonicalEnd);
break; // discard the 2 trailing null bits
}
// STEP n = 2: Read the 3rd Char in a 8-Chars subblock
// Leave 7 bits, asserting there's another encoding Char
if ((digit = (int)chars[charsOffset + 2] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
lastDigit |= (byte)(digit << 1);
// STEP n = 7: Read the 4th Char in a 8-chars Subblock
// Insert 1 bit, leave 4 bits, possibly trailing if no more Char
if ((digit = (int)chars[charsOffset + 3] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
bytes[bytesOffset + 1] = (byte)((digit >> 4) | lastDigit);
lastDigit = (byte)((digit & 15) << 4);
if (charsLen == 4) {
if (lastDigit != 0)
throw new IllegalArgumentException(errorNonCanonicalEnd);
break; // discard the 4 trailing null bits
}
// STEP n = 4: Read the 5th Char in a 8-Chars subblock
// Insert 4 bits, leave 1 bit, possibly trailing if no more Char
if ((digit = (int)chars[charsOffset + 4] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
bytes[bytesOffset + 2] = (byte)((digit >> 1) | lastDigit);
lastDigit = (byte)((digit & 1) << 7);
if (charsLen == 5) {
if (lastDigit != 0)
throw new IllegalArgumentException(errorNonCanonicalEnd);
break; // discard the 1 trailing null bit
}
// STEP n = 1: Read the 6th Char in a 8-Chars subblock
// Leave 6 bits, asserting there's another encoding Char
if ((digit = (int)chars[charsOffset + 5] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
lastDigit |= (byte)(digit << 2);
// STEP n = 6: Read the 7th Char in a 8-Chars subblock
// Insert 2 bits, leave 3 bits, possibly trailing if no more Char
if ((digit = (int)chars[charsOffset + 6] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
bytes[bytesOffset + 3] = (byte)((digit >> 3) | lastDigit);
lastDigit = (byte)((digit & 7) << 5);
if (charsLen == 7) {
if (lastDigit != 0)
throw new IllegalArgumentException(errorNonCanonicalEnd);
break; // discard the 3 trailing null bits
}
// STEP n = 3: Read the 8th Char in a 8-Chars subblock
// Insert 5 bits, leave 0 bit, next encoding Char may not exist
if ((digit = (int)chars[charsOffset + 7] - charDigitsBase) < 0
|| digit >= charDigitsLen
|| (digit = charDigits[digit]) == -1)
throw new IllegalArgumentException(errorInvalidChar);
bytes[bytesOffset + 4] = (byte)(digit | lastDigit);
//// This point is always reached for chars.length multiple of 8
charsOffset += 8;
bytesOffset += 5;
charsLen -= 8;
}
// On loop exit, discard the n trailing null bits
return bytes;
}
/*
// For tests only, take a command-line argument in Base32,
// decode, print in hex, encode, print, and check performance.
static Object noOp(final Object o) {return null;}
static public void main(String[] args) {
if (args.length == 0) {
System.out.println("Supply a Base32-encoded argument...");
return;
}
System.out.print (" Original string: ");
System.out.println(args[0]);
//// decode() test. May fail if parameter not canonical
byte[] bytes = decode(args[0]);
System.out.print (" Decoded bytes:");
for(int i = 0; i < bytes.length ; i++) {
int b = bytes[i] & 255;
System.out.print(' ');
System.out.print((Integer.toHexString(b + 256)).substring(1));
}
System.out.println();
//// encode() test (should match input parameter string)
System.out.print ("Reencoded string: ");
String reencoded = encode(bytes);
System.out.println(reencoded);
//// decode test (should also match previously decoded bytes)
System.out.print (" Redecoded bytes:");
byte[] redecoded = decode(reencoded);
for(int i = 0; i < bytes.length ; i++) {
int b = redecoded[i] & 255;
System.out.print(' ');
System.out.print((Integer.toHexString(b + 256)).substring(1));
}
System.out.println();
//// Performance test
System.out.print("Computing number of loops for performance tests...");
Object dummy = null;
long before = 0, after = 0;
double ms = 0, extra;
int loopsTest;
// Dynamically find the number of loops needed to reach a total
// time of at least 4000ms, so that we compute the precise average
// extra time to perform a loop of static calls doing nothing.
// This is guaranteed not to require more than either 8 seconds or
// the time to perform 1000 dummy loops, and we won't continue
// if we've got already 1.4 billion dummy loops.
for (loopsTest = 1000;
loopsTest < 1400000000 && after - before < 4000;
loopsTest += loopsTest / 2) {
before = System.currentTimeMillis();
for (int loop = loopsTest; --loop >= 0; ) dummy = noOp(dummy);
after = System.currentTimeMillis();
ms = (double)(after - before) / (double)loopsTest;
System.out.print('.');
}
System.out.println();
System.out.println("Average time per static call: " +
new Double(ms).toString() + "ms (computed on " +
Integer.valueOf(loopsTest).toString() + " loops)");
// Cap the number of loops found above so that the above dummy
// tests would not have taken more than 500ms to perform
extra = 500.0 / ms;
System.out.println("Average static call performance: " +
new Double(extra / 500.0 * 1000).toString() + " calls/s");
if ((double)loopsTest >= extra)
loopsTest = (int)extra;
// Keep this precise extra time per loop of static dummy calls
extra = ms;
System.out.println("Starting performance tests on " +
Integer.valueOf(loopsTest).toString() + " call loops.");
//// encode() performance test
before = System.currentTimeMillis();
for (int loop = loopsTest; --loop >= 0; ) reencoded = encode(bytes);
after = System.currentTimeMillis();
ms = (double)(after - before) / (double)loopsTest - extra;
System.out.println("encode() time: " +
new Double(ms).toString() + "ms per call");
System.out.println("encode() input: " +
new Double(bytes.length / ms).toString() + " bytes/ms");
//// decode() performance test
before = System.currentTimeMillis();
for (int loop = loopsTest; --loop >= 0; ) bytes = decode(reencoded);
after = System.currentTimeMillis();
ms = (double)(after - before) / (double)loopsTest - extra;
System.out.println("decode() time: " +
new Double(ms).toString() + "ms per call");
System.out.println("decode() output: " +
new Double(bytes.length / ms).toString() + " bytes/ms");
}
*/
}
The table below shows all metrics for Base32.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 12.00 | Number of blocks | |
| BLOCK_COMMENT | 98.00 | Number of block comment lines | |
| COMMENTS | 151.00 | Comment lines | |
| COMMENT_DENSITY | 1.08 | Comment density | |
| COMPARISONS | 38.00 | Number of comparison operators | |
| CYCLOMATIC | 43.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 9.00 | Comments in declarations | |
| DOC_COMMENT | 17.00 | Number of javadoc comment lines | |
| ELOC | 140.00 | Effective lines of code | |
| EXEC_COMMENTS | 18.00 | Comments in executable code | |
| EXITS | 1.00 | Procedure exits | |
| FUNCTIONS | 2.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 168.19 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 17.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 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 12.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 | 2.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 | 27.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 | 2.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 1.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 4.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 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 313.00 | Number of lines in the source file | |
| LINE_COMMENT | 36.00 | Number of line comments | |
| LOC | 153.00 | Lines of code | |
| LOGICAL_LINES | 80.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 501.00 | Number of operands | |
| OPERATORS | 931.00 | Number of operators | |
| PARAMS | 2.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1432.00 | Halstead program length | |
| PROGRAM_VOCAB | 117.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 15.00 | Number of return points from functions | |
| SIZE | 15501.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 70.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 9.00 | Number of whitespace lines | |