SpellProgressionCache.java
| Index Score | ||
|---|---|---|
 |
 |
pcgen.core |
 |
 |
PCGen |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| SIZE | Size of the file in bytes | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| CYCLOMATIC | Cyclomatic complexity | |
| RETURNS | Number of return points from functions | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOOPS | Number of loops | |
| BLOCKS | Number of blocks | |
| WHITESPACE | Number of whitespace lines | |
| UNIQUE_OPERATORS | Number of unique operators | |
/*
* PCLevelCastingInfo.java
* Copyright 2006 (C) Tom Parker <thpr@users.sourceforge.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Created: November 8, 2006
*
* $Id: PCClass.java 1605 2006-11-08 02:14:21Z thpr $
*/
package pcgen.core;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.Map.Entry;
import pcgen.base.formula.Formula;
/**
* SpellProgressionInfo contains information about Spell Progression in support
* of a PCClass.
*
* @author Tom Parker <thpr@users.sourceforge.net>
*/
public class SpellProgressionCache implements Cloneable {
/*
* FUTURETYPESAFETY Currently can't do better than String in knownMap,
* castMap and specialtyKnownMap, because each one of these can be a
* formula, or some special gunk for Psionicists (can we clean up the +d??)
*/
/**
* This is a Progression of KNOWN spells.
*/
private Progression knownProgression = null;
/**
* This is a Progression KNOWN spells added by a specialty.
*/
private Progression specialtyKnownProgression = null;
/**
* This is a Progression of CAST spells.
*/
private Progression castProgression = null;
/**
* Sets the Known spells for the given class level for this
* SpellProgression. The given character level must be greater than or equal
* to one.
*
* Note that this is a SET (not an ADD) and will therefore OVERWRITE a KNOWN
* spell progression for the given class level if one is already present
* within this SpellProgression.
*
* @param iLevel
* The class level for which the given known spell progression
* applies.
* @param aList
* The known spell progression for the given class level.
* @return The previously set KNOWN spell progression for the given class
* level; null if no KNOWN spell progression was previously set.
*/
public List<Formula> setKnown(int iLevel, List<Formula> aList) {
if (knownProgression == null) {
knownProgression = new Progression();
}
return knownProgression.setProgression(iLevel, aList);
}
/**
* Returns true if this SpellProgression contains a KNOWN spell progression.
* (this is not required, e.g. OGL Wizards do not have a KNOWN spell
* progression, rather they are limited by what spells are in their
* spellbook(s))
*
* @return True if this SpellProgression contains a known spell progression;
* false otherwise.
*/
public boolean hasKnownProgression() {
return knownProgression != null && knownProgression.hasProgression();
}
/**
* Returns the known spell progression for this SpellProgression.
*
* **WARNING** This method exposes the internal contents of this
* SpellProgression object. This method is therefore reference-semantic, and
* the returned Map and the Lists contained within the Map should be
* considered owned by this SpellProgression. The returned Map and Lists it
* contains should not be altered.
*
* CONSIDER How to get rid of this - it makes this Object accidentally
* mutable. - thpr 11/8/06
*
* @return The known spell progression for this SpellProgression object.
*/
public Map<Integer, List<Formula>> getKnownProgression() {
return knownProgression == null ? null : knownProgression
.getProgression();
}
/**
* Returns the known spell progression for the given class level. If this
* SpellProgression does not contain a KNOWN spell progression or if the
* given class level is not high enough to have known spells, this method
* returns null.
*
* This method is value-semantic. Ownership of the returned List is
* transferred to the calling object (The returned list can be modified
* without impacting the internal contents of this SpellProgression)
*
* @param aInt
* The class level for which the known spell progression should
* be returned.
* @return The known spell progression for the given class level, or null if
* there is no known spell progression for the given class level.
*/
public List<Formula> getKnownForLevel(int aLevel) {
return knownProgression == null ? null : knownProgression
.getProgressionForLevel(aLevel);
}
/**
* Returns the highest possible known spell level in this SpellProgression.
*
* Note that this is a theoretical highest level, and based on the abilities
* of a PlayerCharacter, the highest known spell level may not be available
* to that PlayerCharacter.
*
* There are at least two known situations where the theoretical known spell
* level is higher than what a specific PlayerCharacter could actually know:
* (1) When a Stat limits the level of spells that a given PlayerCharacter
* can learn (2) When a Class grants 0 known spells, but some
* PlayerCharacters could have a Stat that provides bonus spells [this
* method WILL return a spell level where a Class grants 0 spells, since
* this is a theoretical limit test.]
*
* @return The highest possible known spell level.
*/
public int getHighestKnownSpellLevel() {
return knownProgression == null ? 0 : knownProgression
.getHighestSpellLevel();
}
/**
* Sets the KNOWN SPECIALTY spells for the given class level for this
* SpellProgression. The given character level must be greater than or equal
* to one.
*
* Note that this is a SET (not an ADD) and will therefore OVERWRITE a KNOWN
* SPECIALTY spell progression for the given class level if one is already
* present within this SpellProgression.
*
* @param iLevel
* The class level for which the given known specialty spell
* progression applies.
* @param aList
* The known specialty spell progression for the given class
* level.
* @return The previously set KNOWN SPECIALTY spell progression for the
* given class level; null if no KNOWN SPECIALTY spell progression
* was previously set.
*/
public List<Formula> setSpecialtyKnown(int aLevel, List<Formula> aList) {
if (specialtyKnownProgression == null) {
specialtyKnownProgression = new Progression();
}
return specialtyKnownProgression.setProgression(aLevel, aList);
}
/**
* Returns true if this SpellProgression contains KNOWN SPECIALTY spell
* progressions. (this is not required, e.g. most 3.0SRD classes do not have
* a KNOWN SPECIALTY list)
*
* @return True if this SpellProgression contains a known specialty spell
* progression; false otherwise.
*/
public boolean hasSpecialtyKnownProgression() {
return specialtyKnownProgression != null
&& specialtyKnownProgression.hasProgression();
}
/**
* Returns the known specialty spell progression for this SpellProgression.
*
* **WARNING** This method exposes the internal contents of this
* SpellProgression object. This method is therefore reference-semantic, and
* the returned Map and the Lists contained within the Map should be
* considered owned by this SpellProgression. The returned Map and Lists it
* contains should not be altered.
*
* CONSIDER How to get rid of this - it makes this Object accidentally
* mutable. - thpr 11/8/06
*
* @return The known specialty spell progression for this SpellProgression
* object.
*/
public Map<Integer, List<Formula>> getSpecialtyKnownMap() {
return specialtyKnownProgression == null ? null
: specialtyKnownProgression.getProgression();
}
/**
* Returns the known specialty spell progression for the given class level.
* If this SpellProgression does not contain a KNOWN SPECIALTY spell
* progression or if the given class level is not high enough to have
* entered the known specialty spell progression, this method returns null.
*
* This method is value-semantic. Ownership of the returned List is
* transferred to the calling object (The returned list can be modified
* without impacting the internal contents of this SpellProgression)
*
* @param aInt
* The class level for which the known specialty spell
* progression should be returned.
* @return The known specialty spell progression for the given class level,
* or null if there is no known specialty spell progression for the
* given class level.
*/
public List<Formula> getSpecialtyKnownForLevel(int aLevel) {
return specialtyKnownProgression == null ? null
: specialtyKnownProgression.getProgressionForLevel(aLevel);
}
/**
* Sets the CAST spells for the given class level for this SpellProgression.
* The given character level must be greater than or equal to one.
*
* Note that this is a SET (not an ADD) and will therefore OVERWRITE a CAST
* spell progression for the given class level if one is already present
* within this SpellProgression.
*
* @param iLevel
* The class level for which the given CAST spell progression
* applies.
* @param aList
* The CAST spell progression for the given class level.
* @return The previously set CAST spell progression for the given class
* level; null if no CAST spell progression was previously set.
*/
public List<Formula> setCast(int aLevel, List<Formula> aList) {
if (castProgression == null) {
castProgression = new Progression();
}
return castProgression.setProgression(aLevel, aList);
}
/**
* Returns true if this SpellProgression contains CAST spell progressions.
* (this is not required, but would be a bit strange to be empty)
*
* @return True if this SpellProgression contains a CAST spell progression;
* false otherwise.
*/
public boolean hasCastProgression() {
return castProgression != null && castProgression.hasProgression();
}
/**
* Returns the CAST spell progression for this SpellProgression.
*
* **WARNING** This method exposes the internal contents of this
* SpellProgression object. This method is therefore reference-semantic, and
* the returned Map and the Lists contained within the Map should be
* considered owned by this SpellProgression. The returned Map and Lists it
* contains should not be altered.
*
* CONSIDER How to get rid of this - it makes this Object accidentally
* mutable. - thpr 11/8/06
*
* @return The CAST spell progression for this SpellProgression object.
*/
public Map<Integer, List<Formula>> getCastProgression() {
return castProgression == null ? null : castProgression
.getProgression();
}
/**
* Returns the CAST spell progression for the given class level. If this
* SpellProgression does not contain a CAST spell progression or if the
* given class level is not high enough to have CAST spells, this method
* returns null.
*
* This method is value-semantic. Ownership of the returned List is
* transferred to the calling object (The returned list can be modified
* without impacting the internal contents of this SpellProgression)
*
* @param aInt
* The class level for which the CAST spell progression should be
* returned.
* @return The CAST spell progression for the given class level, or null if
* there is no CAST spell progression for the given class level.
*/
public List<Formula> getCastForLevel(int aLevel) {
return castProgression == null ? null : castProgression
.getProgressionForLevel(aLevel);
}
/**
* Returns the highest possible CAST spell level in this SpellProgression.
*
* Note that this is a theoretical highest level, and based on the abilities
* of a PlayerCharacter, the highest CAST spell level may not be available
* to that PlayerCharacter.
*
* There are at least two known situations where the theoretical CAST spell
* level is higher than what a specific PlayerCharacter could actually know:
* (1) When a Stat limits the level of spells that a given PlayerCharacter
* can learn (2) When a Class grants 0 CAST spells, but some
* PlayerCharacters could have a Stat that provides bonus spells [this
* method WILL return a spell level where a Class grants 0 spells, since
* this is a theoretical limit test.]
*
* @return The highest possible CAST spell level.
*/
public int getHighestCastSpellLevel() {
return castProgression == null ? 0 : castProgression
.getHighestSpellLevel();
}
/**
* Returns the minimum class level required to acquire a spell of the given
* spell level (and potential application of bonuses).
*
* There are two situations that can also be distinguished:
*
* If allowBonus is true, then this will return a class level where the CAST
* or KNOWN spell count is equal to zero (since it assumes that bonuses
* could provide that spell level). This DOES NOT return a class level where
* a spell count is "-" (or spells are not available at all).
*
* If allowBonus is false, this this will return a class level where the
* CAST or KNOWN spell count is greater than zero (since no bonuses would be
* applied to make the spell count a non-zero value)
*
* *WARNING* This method is KNOWN to be broken if this SpellProgressionInfo
* contains a spell formula. Analysis must be done in context to the formula
* in that case.
*
* @param spellLevel
* The spell level for which the minimum required class level
* will be returned
* @param allowBonus
* true if the class level is allowed to have a "0" CAST or KNOWN
* spell count.
* @return The minimum class level required to acquire a spell of the given
* spell level (and potential application of bonuses)
*/
public int getMinLevelForSpellLevel(int spellLevel, boolean allowBonus) {
if (castProgression != null) {
int lvl = castProgression.getMinLevelForSpellLevel(spellLevel,
allowBonus);
if (lvl != -1) {
return lvl;
}
}
/*
* CONSIDER Should the castMap really dominate the knownMap like this??? -
* I know that it probably returns the intended result, but it needs to
* be explained better in the comments. - thpr 11/9/06
*/
if (knownProgression != null) {
int lvl = knownProgression.getMinLevelForSpellLevel(spellLevel,
allowBonus);
if (lvl != -1) {
return lvl;
}
}
return -1;
}
/**
* Returns the theoretical maximum spell level for the given class level.
*
* Note that this is a theoretical highest level, and based on the abilities
* of a PlayerCharacter, the highest spell level may not be available to
* that PlayerCharacter.
*
* This theoretical test WILL return a spell level where the class grants 0
* known or cast spells, as bonuses acquired from Stats can provide use of
* that spell level.
*
* @param classLevel
* The class level for which the theoretical maximum spell level
* should be returned.
* @return The theoretical maximum spell level for the given class level; -1
* if this SpellProgressionInfo does not contain any KNOWN or CAST
* spell progressions for the given class level.
*/
public int getMaxSpellLevelForClassLevel(int classLevel) {
/*
* Delegation to get*ForLevel is required because it is possible that
* the given class level itself does not have a CAST or KNOWN
* progression, but that a lower level does. Those methods account for
* that situation.
*/
if (castProgression != null) {
List<Formula> knownList = castProgression
.getProgressionForLevel(classLevel);
if (knownList != null) {
return knownList.size() - 1;
}
}
if (knownProgression != null) {
List<Formula> knownList = knownProgression
.getProgressionForLevel(classLevel);
if (knownList != null) {
return knownList.size() - 1;
}
}
return -1;
}
/**
* Clones this SpellProgressionInfo object. A semi-deep (or semi-shallow,
* depending on one's point of view) clone is performed, under the
* assumption that the cloned object should be allowed to have any of the
* SpellProgressionInfo.set* method called without allowing either the
* original or the cloned SpellProgressionInfo object to accidentally modify
* the other.
*
* There is the assumption, however, that the Lists contained within the
* SpellProgressionInfo object are never modified, and violation of that
* semantic rule either within SpellProgressionInfo or by other objects
* which call the reference-semantic methods of SpellProgressionInfo can
* render this clone insufficient.
*
* @return A semi-shallow Clone of this SpellProgressionInfo object.
* @throws CloneNotSupportedException
*/
@Override
public SpellProgressionCache clone() throws CloneNotSupportedException {
SpellProgressionCache spi = (SpellProgressionCache) super.clone();
/*
* Each of knownMap, specialtyKnownMap, and castMap need one level deep
* clones. Since the Lists that are stored are never individually
* modified in SpellProgressionInfo (they are always overwritten by a
* new set*) there is no need to do a full depth clone. However, the one
* level deep clone is required in case there is a PCClass.COPY or
* something that then mods a KNOWN or CAST.
*/
if (knownProgression != null) {
spi.knownProgression = knownProgression.clone();
}
if (specialtyKnownProgression != null) {
spi.specialtyKnownProgression = specialtyKnownProgression.clone();
}
if (castProgression != null) {
spi.castProgression = castProgression.clone();
}
return spi;
}
/*
* CONSIDER Do I want an "isValid" method to check that spell type is
* defined, et al?? - ensure consistency? - thpr 11/9/06
*/
/**
* Stores an individual Progression within this SpellProgressionInfo. Broken
* out as a separate class in order to maintain consistent behavior and
* avoid a ton of redundant code within SpellProgressionInfo.
*/
private static class Progression implements Cloneable {
/**
* This is a Map of spells. The Integer key is the Class level, the
* value is a List of constants or Formula for each SpellLevel.
*
* The progressionMap must not contain any null values.
*/
private TreeMap<Integer, List<Formula>> progressionMap = null;
/**
* Sets the spells for the given class level for this Progression. The
* given character level must be greater than or equal to one.
*
* Note that this is a SET (not an ADD) and will therefore OVERWRITE a
* spell progression for the given class level if one is already present
* within this Progression.
*
* @param iLevel
* The class level for which the given spell progression
* applies.
* @param aList
* The spell progression for the given class level.
* @return The previously set spell progression for the given class
* level; null if no spell progression was previously set.
*/
public List<Formula> setProgression(int iLevel, List<Formula> aList) {
if (iLevel < 1) {
throw new IllegalArgumentException(
"Level must be >= 1 in spell progression");
}
if (aList == null) {
throw new IllegalArgumentException(
"Cannot add null spell progression list to level "
+ iLevel);
}
if (aList.isEmpty()) {
throw new IllegalArgumentException(
"Cannot add empty spell progression list to level "
+ iLevel);
}
if (aList.contains(null)) {
throw new IllegalArgumentException(
"Cannot have null value in spell progrssion list in level "
+ iLevel);
}
if (progressionMap == null) {
progressionMap = new TreeMap<Integer, List<Formula>>();
}
return progressionMap.put(iLevel, new ArrayList<Formula>(aList));
}
public int getMinLevelForSpellLevel(int spellLevel, boolean allowBonus) {
for (Entry<Integer, List<Formula>> me : progressionMap.entrySet()) {
List<Formula> progressionList = me.getValue();
for (int lvl = spellLevel; lvl < progressionList.size(); lvl++) {
/*
* This for loop is to protect against a (admittedly
* strange) class that grants N + 1 level spells, but not N
* and N is the spellLevel parameter to this method.
*/
/*
* FIXME This will break if there are spell formulae - thpr
* 11/9/06
*/
if (allowBonus
|| Integer.parseInt(progressionList.get(lvl).toString()) != 0) {
return me.getKey();
}
}
}
return -1;
}
/**
* Returns true if this Progression contains a spell progression.
*
* @return True if this Progression contains a spell progression; false
* otherwise.
*/
public boolean hasProgression() {
return progressionMap != null;
}
/**
* Returns the spell progression for this Progression.
*
* **WARNING** This method exposes the internal contents of this
* Progression object. This method is therefore reference-semantic, and
* the returned Map and the Lists contained within the Map should be
* considered owned by this Progression. The returned Map and Lists it
* contains should not be altered.
*
* CONSIDER How to get rid of this - it makes this Object accidentally
* mutable. - thpr 11/8/06
*
* @return The spell progression for this Progression object.
*/
public Map<Integer, List<Formula>> getProgression() {
if (progressionMap == null) {
return null;
}
return progressionMap;
}
/**
* Returns the spell progression for the given class level. If this
* Progression does not contain a spell progression or if the given
* class level is not high enough to have spells, this method returns
* null.
*
* This method is value-semantic. Ownership of the returned List is
* transferred to the calling object (The returned list can be modified
* without impacting the internal contents of this Progression)
*
* @param classLevel
* The class level for which the spell progression should be
* returned.
* @return The spell progression for the given class level, or null if
* there is no spell progression for the given class level.
*/
public List<Formula> getProgressionForLevel(int classLevel) {
List<Formula> spellProgression = null;
boolean found = false;
if(progressionMap != null) {
Integer key = Integer.valueOf(classLevel);
if (!progressionMap.containsKey(key)) {
//No spellcasting at level key, check previous levels
if (progressionMap.firstKey() < classLevel) {
key = progressionMap.headMap(key).lastKey();
found = true;
}
} else {
found = true;
}
if(found) {
List<Formula> list = progressionMap.get(key);
spellProgression = new ArrayList<Formula>(list);
}
}
return spellProgression;
}
/**
* Returns the highest possible spell level in this Progression.
*
* Note that this is a theoretical highest level, and based on the
* abilities of a PlayerCharacter, the highest spell level may not be
* available to that PlayerCharacter.
*
* There are at least two known situations where the theoretical spell
* level is higher than what a specific PlayerCharacter could actually
* know: (1) When a Stat limits the level of spells that a given
* PlayerCharacter can learn (2) When a Class grants 0 known spells, but
* some PlayerCharacters could have a Stat that provides bonus spells
* [this method WILL return a spell level where a Class grants 0 spells,
* since this is a theoretical limit test.]
*
* @return The highest possible spell level in this Progression.
*/
public int getHighestSpellLevel() {
if (progressionMap != null) {
int highest = -1;
for (List<Formula> list : progressionMap.values()) {
highest = Math.max(highest, list.size() - 1);
}
return highest;
}
return -1;
}
/**
* Clones this Progression object. A semi-deep (or semi-shallow,
* depending on one's point of view) clone is performed, under the
* assumption that the cloned object should be allowed to have the
* Progression.set* method called without allowing either the original
* or the cloned Progression object to accidentally modify the other.
*
* There is the assumption, however, that the Lists contained within the
* Progression object are never modified, and violation of that semantic
* rule either within Progression or by other objects which call the
* reference-semantic methods of Progression can render this clone
* insufficient.
*
* @return A semi-shallow Clone of this Progression object.
* @throws CloneNotSupportedException
*/
@Override
public Progression clone() throws CloneNotSupportedException {
Progression p = (Progression) super.clone();
if (progressionMap != null) {
p.progressionMap = new TreeMap<Integer, List<Formula>>(
progressionMap);
}
return p;
}
}
public boolean isEmpty()
{
return knownProgression == null && castProgression == null
&& specialtyKnownProgression == null;
}
}
The table below shows all metrics for SpellProgressionCache.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 56.00 | Number of blocks | |
| BLOCK_COMMENT | 59.00 | Number of block comment lines | |
| COMMENTS | 436.00 | Comment lines | |
| COMMENT_DENSITY | 2.81 | Comment density | |
| COMPARISONS | 56.00 | Number of comparison operators | |
| CYCLOMATIC | 67.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 32.00 | Comments in declarations | |
| DOC_COMMENT | 376.00 | Number of javadoc comment lines | |
| ELOC | 155.00 | Effective lines of code | |
| EXEC_COMMENTS | 6.00 | Comments in executable code | |
| EXITS | 25.00 | Procedure exits | |
| FUNCTIONS | 25.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 71.14 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 57.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 5.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 5.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 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 | 2.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 | 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 | 1133.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 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 | 685.00 | Number of lines in the source file | |
| LINE_COMMENT | 1.00 | Number of line comments | |
| LOC | 213.00 | Lines of code | |
| LOGICAL_LINES | 74.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 376.00 | Number of operands | |
| OPERATORS | 875.00 | Number of operators | |
| PARAMS | 17.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1251.00 | Halstead program length | |
| PROGRAM_VOCAB | 153.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 40.00 | Number of return points from functions | |
| SIZE | 26384.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 111.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 42.00 | Number of unique operators | |
| WHITESPACE | 36.00 | Number of whitespace lines | |