FilterFactory.java
| Index Score | ||
|---|---|---|
 |
 |
pcgen.gui.filter |
 |
 |
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 | |
|---|---|---|
| INTERFACE_COMPLEXITY | Interface complexity |  |
| RETURNS | Number of return points from functions | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| DECL_COMMENTS | Comments in declarations | |
| PARAMS | Number of formal parameter declarations | |
| FUNCTIONS | Number of function declarations | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| SIZE | Size of the file in bytes | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| COMPARISONS | Number of comparison operators | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| WHITESPACE | Number of whitespace lines | |
| COMMENTS | Comment lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| EXEC_COMMENTS | Comments in executable code | |
| BLOCK_COMMENT | Number of block comment lines | |
| LOOPS | Number of loops | |
| DOC_COMMENT | Number of javadoc comment lines | |
| LINE_COMMENT | Number of line comments | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0058 | JAVA0058 Constructor calls super() | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| NEST_DEPTH | Maximum nesting depth | |
/*
* FilterFactory.java
* Copyright 2002 (C) Thomas Behr <ravenlock@gmx.de>
*
* 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 on February 12, 2002, 13:30 PM
*/
package pcgen.gui.filter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import pcgen.base.formula.Formula;
import pcgen.cdom.base.CDOMReference;
import pcgen.cdom.base.Constants;
import pcgen.cdom.enumeration.FormulaKey;
import pcgen.cdom.enumeration.ListKey;
import pcgen.cdom.enumeration.ObjectKey;
import pcgen.cdom.enumeration.Pantheon;
import pcgen.cdom.enumeration.RaceSubType;
import pcgen.cdom.enumeration.RaceType;
import pcgen.core.Ability;
import pcgen.core.Campaign;
import pcgen.core.Deity;
import pcgen.core.Domain;
import pcgen.core.Equipment;
import pcgen.core.Globals;
import pcgen.core.PCAlignment;
import pcgen.core.PCClass;
import pcgen.core.PCTemplate;
import pcgen.core.PObject;
import pcgen.core.PlayerCharacter;
import pcgen.core.Race;
import pcgen.core.SettingsHandler;
import pcgen.core.SizeAdjustment;
import pcgen.core.Skill;
import pcgen.core.WeaponProf;
import pcgen.core.analysis.SkillModifier;
import pcgen.core.prereq.Prerequisite;
import pcgen.core.spell.Spell;
import pcgen.core.utils.CoreUtility;
import pcgen.persistence.PersistenceManager;
import pcgen.util.Logging;
import pcgen.util.PropertyFactory;
import pcgen.util.enumeration.Visibility;
/**
* <code>FilterFactory</code>
* <br>
* Factory class for creating standard PObjectFilter objects
*
* Wherever possible, this factory will hand out references to shared
* PObjectFilter instances
*
* @author Thomas Behr
* @version $Revision: 7367 $
*/
public final class FilterFactory implements FilterConstants
{
private static List<PObjectFilter> campaignFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> classFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> deityFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> equipmentFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> featFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> prereqAlignmentFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> raceFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> sizeFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> skillFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> sourceFilters = new ArrayList<PObjectFilter>();
private static List<PObjectFilter> spellFilters = new ArrayList<PObjectFilter>();
private static Map<String, String> filterSettings = new HashMap<String, String>();
private static final String MODE_SETTING = "mode"; //$NON-NLS-1$
private static final String AVAILABLE_SETTING = "available"; //$NON-NLS-1$
private static final String SELECTED_SETTING = "selected"; //$NON-NLS-1$
private static final String REMOVED_SETTING = "removed"; //$NON-NLS-1$
/**
* clears the filter cache for updates/re-initialization
* of filter settings
*
* <br>author: Thomas Behr 07-03-02
*/
public static void clearFilterCache()
{
campaignFilters.clear();
classFilters.clear();
deityFilters.clear();
equipmentFilters.clear();
featFilters.clear();
prereqAlignmentFilters.clear();
raceFilters.clear();
skillFilters.clear();
sourceFilters.clear();
spellFilters.clear();
}
/**
* Create a PC Class Filter
* @return PC Class Filter
*/
public static PObjectFilter createPCClassFilter()
{
return new PCClassFilter();
}
/**
* convience method
*
* <br>author: Thomas Behr 20-02-02
* @param filterList
* @return String
*/
public static String filterListToString(final List<?> filterList)
{
StringBuffer buffer = new StringBuffer();
for ( final Object filter : filterList )
{
buffer.append('[').append(filter.getClass().getName());
buffer.append(Constants.PIPE).append(filter.toString()).append(']');
}
return buffer.toString();
}
/**
* Register all class filters
* @param fap
*/
public static void registerAllClassFilters(FilterAdapterPanel fap)
{
if (classFilters.size() == 0)
{
classFilters.add(FilterFactory.createQualifyFilter());
Set<String> typeSet = new HashSet<String>();
for (PCClass cl : Globals.getContext().ref.getConstructedCDOMObjects(PCClass.class))
{
typeSet.addAll(cl.getTypeList(false));
}
// e.g. "Base", "Monster", "NPC", "PC", "Prestige" + more
for ( final String subType : typeSet )
{
//All TYPEs should already be tokenized into subtypes by the "."
classFilters.add(FilterFactory.createTypeFilter(subType, subType.length() > 3));
//If 2nd param of createTypeFilter is "false" then the filter created
// will preserve capitalization of subtypes
//In this case, types of 3-letters or less will be preserved (typically, "PC" and "NPC")
}
// TODO - Create Globals.getAllSpellTypes()
classFilters.add(FilterFactory.createSpellTypeFilter("Arcane")); //$NON-NLS-1$
classFilters.add(FilterFactory.createSpellTypeFilter("Divine")); //$NON-NLS-1$
classFilters.add(FilterFactory.createSpellTypeFilter("Psionic")); //$NON-NLS-1$
}
for ( final PObjectFilter filter : classFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all of the deity filters
* @param fap
*/
public static void registerAllDeityFilters(FilterAdapterPanel fap)
{
if (deityFilters.size() == 0)
{
deityFilters.add(FilterFactory.createQualifyFilter());
deityFilters.add(FilterFactory.createPCAlignmentFilter());
// TODO - Check if Alignments should be used.
final int numAlign = SettingsHandler.getGame().getUnmodifiableAlignmentList().size();
for (int i = 0; i < numAlign; i++)
{
deityFilters.add(FilterFactory.createAlignmentFilter(i));
}
for ( final Domain domain : Globals.getContext().ref.getConstructedCDOMObjects(Domain.class) )
{
deityFilters.add(FilterFactory.createDomainFilter(domain));
}
deityFilters.add(FilterFactory.createPantheonFilter(Constants.LST_ALL, PantheonFilter.Detail.HIGH));
for ( final Pantheon pantheon : Pantheon.getAllConstants() )
{
// TODO - What are we doing with the indexOf " ("??
deityFilters.add(FilterFactory.createPantheonFilter(pantheon.toString(),
(pantheon.toString().indexOf(" (") > -1) //$NON-NLS-1$
? PantheonFilter.Detail.HIGH
: PantheonFilter.Detail.LOW));
}
}
for ( final PObjectFilter filter : deityFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all of the equipment filters
* @param fap
*/
public static void registerAllEquipmentFilters(FilterAdapterPanel fap)
{
if (equipmentFilters.size() == 0)
{
equipmentFilters.add(FilterFactory.createQualifyFilter());
equipmentFilters.add(FilterFactory.createNonMagicFilter());
equipmentFilters.add(FilterFactory.createAffordableFilter());
for ( final String type : Equipment.getEquipmentTypes() )
{
equipmentFilters.add(FilterFactory.createTypeFilter(type));
}
for (final String s : SettingsHandler.getGame().getContext().getTypes(WeaponProf.class))
{
// weapon types come in pairs:
// first UPPERCASE only, than Capitalized
// so only register the Capitalized one
equipmentFilters.add(FilterFactory.createWeaponFilter(s));
}
equipmentFilters.add(FilterFactory.createPCSizeFilter());
}
for ( final PObjectFilter filter : equipmentFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all feat filters
* @param fap
*/
public static void registerAllFeatFilters(FilterAdapterPanel fap)
{
if (featFilters.size() == 0)
{
featFilters.add(FilterFactory.createQualifyFilter());
featFilters.add(FilterFactory.createAutomaticFeatFilter());
featFilters.add(FilterFactory.createNormalFeatFilter());
featFilters.add(FilterFactory.createVirtualFeatFilter());
}
for ( final PObjectFilter filter : featFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all pre req alignment filters
* @param fap
*/
public static void registerAllPrereqAlignmentFilters(FilterAdapterPanel fap)
{
if (prereqAlignmentFilters.size() == 0)
{
// TODO - Check if Alignments should be used.
final int numAlign = SettingsHandler.getGame().getUnmodifiableAlignmentList().size();
for (int i = 0; i < numAlign; i++)
{
prereqAlignmentFilters.add(FilterFactory.createAlignmentFilter(i, AlignmentFilter.Mode.ALLOWED));
prereqAlignmentFilters.add(FilterFactory.createAlignmentFilter(i, AlignmentFilter.Mode.REQUIRED));
}
prereqAlignmentFilters.add(FilterFactory.createPCAlignmentFilter(AlignmentFilter.Mode.ALLOWED));
prereqAlignmentFilters.add(FilterFactory.createPCAlignmentFilter(AlignmentFilter.Mode.REQUIRED));
}
for ( final PObjectFilter filter : prereqAlignmentFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all race filters
* @param fap
*/
public static void registerAllRaceFilters(FilterAdapterPanel fap)
{
if (raceFilters.size() == 0)
{
raceFilters.add(FilterFactory.createQualifyFilter());
// Create filters for race type and sub type
for (RaceType raceType : RaceType.getAllConstants())
{
raceFilters.add(FilterFactory.createRaceTypeFilter(raceType));
}
for (RaceSubType raceSubType : RaceSubType.getAllConstants())
{
raceFilters.add(FilterFactory.createRaceSubTypeFilter(raceSubType));
}
// Create a favored class filter for each visible Base.PC class.
// TODO - Fix this hardcoding
PObjectFilter filter = FilterFactory.createCompoundFilter(new TypeFilter("Base"), new TypeFilter("PC"), AND); //$NON-NLS-1$ //$NON-NLS-2$
for ( final PCClass pcClass : Globals.getContext().ref.getConstructedCDOMObjects(PCClass.class) )
{
if (pcClass.getSafe(ObjectKey.VISIBILITY).equals(Visibility.DEFAULT) && filter.accept(null, pcClass))
{
raceFilters.add(FilterFactory.createFavoredClassFilter(pcClass.getKeyName()));
}
}
raceFilters.add(FilterFactory.createPCTemplateFilter());
raceFilters.add(FilterFactory.createRaceFilter());
}
for ( final PObjectFilter filter : raceFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all size filters
* @param fap
*/
public static void registerAllSizeFilters(FilterAdapterPanel fap)
{
if (sizeFilters.size() == 0)
{
for (int i = 0; i < SettingsHandler.getGame().getSizeAdjustmentListSize(); i++)
{
sizeFilters.add(FilterFactory.createSizeFilter(i));
}
}
for ( final PObjectFilter filter : sizeFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all skill filters
* @param fap
*/
public static void registerAllSkillFilters(FilterAdapterPanel fap)
{
if (skillFilters.size() == 0)
{
skillFilters.add(FilterFactory.createUntrainedSkillFilter());
skillFilters.add(FilterFactory.createRankFilter(0.0d));
skillFilters.add(FilterFactory.createRankModifierFilter(0.0d));
for (int i = 0; i < SettingsHandler.getGame().s_ATTRIBSHORT.length; i++)
{
skillFilters.add(FilterFactory.createStatFilter(SettingsHandler.getGame().s_ATTRIBSHORT[i]));
}
}
for ( final PObjectFilter filter : skillFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all source filters
* @param fap
*/
public static void registerAllSourceFilters(FilterAdapterPanel fap)
{
if (sourceFilters.size() == 0)
{
sourceFilters.add(FilterFactory.createQualifyFilter());
for ( final String source : PersistenceManager.getInstance().getSources() )
{
sourceFilters.add(FilterFactory.createSourceFilter(source));
}
}
List<PObjectFilter> settingList = new ArrayList<PObjectFilter>();
List<PObjectFilter> genreList = new ArrayList<PObjectFilter>();
for ( final Campaign campaign : Globals.getCampaignList() )
{
if (!campaign.getSetting().equals(Constants.EMPTY_STRING))
{
settingList.add(FilterFactory.createSettingFilter(campaign.getSetting()));
}
if (!campaign.getGenre().equals(Constants.EMPTY_STRING))
{
genreList.add(FilterFactory.createGenreFilter(campaign.getGenre()));
}
}
sourceFilters.addAll(settingList);
sourceFilters.addAll(genreList);
for ( final PObjectFilter filter : sourceFilters )
{
fap.registerFilter(filter);
}
}
/**
* Register all spell filters
* @param fap
*/
public static void registerAllSpellFilters(FilterAdapterPanel fap)
{
if (spellFilters.size() == 0)
{
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.VERBAL.toString()));
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.SOMATIC.toString()));
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.MATERIAL.toString()));
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.DIVINEFOCUS.toString()));
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.FOCUS.toString()));
spellFilters.add(FilterFactory.createComponentFilter(Spell.Component.EXPERIENCE.toString()));
for ( final String castTime : Globals.getCastingTimesSet() )
{
spellFilters.add(FilterFactory.createCastingTimeFilter(castTime));
}
for ( final String descriptor : Globals.getDescriptorSet() )
{
spellFilters.add(FilterFactory.createDescriptorFilter(descriptor));
}
for ( final String target : Globals.getTargetSet() )
{
spellFilters.add(FilterFactory.createEffectTypeFilter(target));
}
for ( final String range : Globals.getRangesSet() )
{
spellFilters.add(FilterFactory.createRangeFilter(range));
}
for ( final String school : SettingsHandler.getGame().getUnmodifiableSchoolsList() )
{
spellFilters.add(FilterFactory.createSchoolFilter(school));
}
for ( final String sr : Globals.getSrSet() )
{
spellFilters.add(FilterFactory.createSpellResistanceFilter(sr));
}
for ( final String subschool : Globals.getSubschools() )
{
spellFilters.add(FilterFactory.createSubschoolFilter(subschool));
}
}
for ( final PObjectFilter filter : spellFilters )
{
fap.registerFilter(filter);
}
}
/**
* reads filter.ini to restore the previous filter settings
* for a given Filterable
*
* @param filterable the Filterable whose settings will be loaded/restored
*
* @return true, if the settings could be restored, false otherwise
*/
public static boolean restoreFilterSettings(Filterable filterable)
{
/*
* bug fix #523167
*/
filterable.getAvailableFilters().clear();
filterable.getSelectedFilters().clear();
filterable.getRemovedFilters().clear();
/*
* initialize standard filters
*/
filterable.initializeFilters();
String name = filterable.getName();
if (name == null)
{
return false;
}
try
{
filterable.setFilterMode(Integer.parseInt(SettingsHandler.retrieveFilterSettings(name + '.' + MODE_SETTING)));
}
catch (NumberFormatException ex)
{
filterable.setFilterMode(FilterConstants.MATCH_ALL);
}
filterSettings.clear();
final List<String[]> customAvailable = preprocessFilterList(AVAILABLE_SETTING,
SettingsHandler.retrieveFilterSettings(name + '.' + AVAILABLE_SETTING));
final List<String[]> customSelected = preprocessFilterList(SELECTED_SETTING,
SettingsHandler.retrieveFilterSettings(name + '.' + SELECTED_SETTING));
final List<String[]> customRemoved = preprocessFilterList(REMOVED_SETTING,
SettingsHandler.retrieveFilterSettings(name + '.' + REMOVED_SETTING));
/*
* move the filters to the appropriate list
*/
for (final Iterator<PObjectFilter> it = filterable.getAvailableFilters().iterator(); it.hasNext();)
{
final PObjectFilter filter = it.next();
final String listType = filterSettings.get(filter.toString());
// TODO - Change filterable to not give out references to the lists
if ((listType == null) || (AVAILABLE_SETTING.equals(listType)))
{
// this is our default case
// do nothing - leave the filter in the available list
}
else if (SELECTED_SETTING.equals(listType))
{
it.remove();
filterable.getSelectedFilters().add(filter);
}
else if (REMOVED_SETTING.equals(listType))
{
it.remove();
filterable.getRemovedFilters().add(filter);
}
}
/*
* restore the custom filters
*/
FilterParser fp = new FilterParser(new List[]
{
filterable.getAvailableFilters(), filterable.getSelectedFilters(), filterable.getRemovedFilters()
});
parseCustomFilterList(fp, filterable.getAvailableFilters(), customAvailable);
parseCustomFilterList(fp, filterable.getSelectedFilters(), customSelected);
parseCustomFilterList(fp, filterable.getRemovedFilters(), customRemoved);
filterable.refreshFiltering();
return (filterable.getAvailableFilters().size() + filterable.getSelectedFilters().size()) > 0;
}
/*
* #################################################################
* factory methods
* all the factory methods are named according to the following
* scheme:
* "create" + <filter class name> + "(" + <arguments>+ ")"
* where <filter class name> refers to the class name of
* the created PObjectFilter.
* for each PObjectFilter factory method there MUST be one
* public PObjectFilter method called:
* "create" + <filter class name> + "(String filterDefinition)"
* this is needed for reflection method calls!
*
* if PObjectFilters are defined locally in Filterables,
* there MUST be one public PObjectFilter method called
* "create" + <filter class name> + "()"
* again, this is needed for reflection method calls!
* #################################################################
*/
/*
* #################################################################
* general factory methods
* #################################################################
*/
static PObjectFilter createCompoundFilter(PObjectFilter filter1, PObjectFilter filter2, String connect)
{
return new CompoundFilter(filter1, filter2, connect);
}
static PObjectFilter createInverseFilter(PObjectFilter filter)
{
return new InverseFilter(filter);
}
static PObjectFilter createNamedFilter(PObjectFilter filter, String name, String description)
{
return new NamedFilter(filter, name, description);
}
/*
* #################################################################
* inventory tab factory methods
* #################################################################
*/
private static PObjectFilter createAffordableFilter()
{
return new AffordableFilter();
}
/*
* #################################################################
* domain tab factory methods
* #################################################################
*/
private static PObjectFilter createAlignmentFilter(int alignment)
{
return new DeityAlignmentFilter(alignment);
}
/*
* #################################################################
* stats tab factory methods
* #################################################################
*/
private static PObjectFilter createAlignmentFilter(int alignment, AlignmentFilter.Mode mode)
{
return new DeityAlignmentFilter(alignment, mode);
}
/*
* #################################################################
* feats tab factory methods
* #################################################################
*/
private static PObjectFilter createAutomaticFeatFilter()
{
return new AutomaticFeatFilter();
}
/*
* #################################################################
* spell tab factory methods
* #################################################################
*/
private static PObjectFilter createCastingTimeFilter(String castingTime)
{
return new CastingTimeFilter(castingTime);
}
private static PObjectFilter createComponentFilter(String component)
{
return new ComponentFilter(component);
}
private static PObjectFilter createDescriptorFilter(String descriptor)
{
return new DescriptorFilter(descriptor);
}
private static PObjectFilter createDomainFilter(Domain domain)
{
return new DomainFilter(domain);
}
private static PObjectFilter createEffectTypeFilter(String effect)
{
return new EffectTypeFilter(effect);
}
private static PObjectFilter createFavoredClassFilter(String className)
{
return new FavoredClassFilter(className);
}
private static PObjectFilter createGenreFilter(String genre)
{
return new GenreFilter(genre);
}
private static PObjectFilter createNonMagicFilter()
{
return new NonMagicFilter();
}
private static PObjectFilter createNormalFeatFilter()
{
return new NormalFeatFilter();
}
private static PObjectFilter createPCAlignmentFilter()
{
return new PCAlignmentFilter();
}
private static PObjectFilter createPCAlignmentFilter(final AlignmentFilter.Mode mode)
{
return new PCAlignmentFilter(mode);
}
private static PObjectFilter createPCSizeFilter()
{
return new PCSizeFilter();
}
private static PObjectFilter createPCTemplateFilter()
{
return new PCTemplateFilter();
}
private static PObjectFilter createPantheonFilter(String race, PantheonFilter.Detail detailLevel)
{
return new PantheonFilter(race, detailLevel);
}
private static PObjectFilter createQualifyFilter()
{
return new QualifyFilter();
}
private static PObjectFilter createRaceFilter()
{
return new RaceFilter();
}
private static PObjectFilter createRaceSubTypeFilter(RaceSubType subType)
{
return new RaceSubTypeFilter(subType);
}
private static PObjectFilter createRaceTypeFilter(RaceType type)
{
return new RaceTypeFilter(type);
}
private static PObjectFilter createRangeFilter(String range)
{
return new RangeFilter(range);
}
/*
* #################################################################
* skill tab factory methods
* #################################################################
*/
private static PObjectFilter createRankFilter(double min)
{
return new RankFilter(min);
}
private static PObjectFilter createRankModifierFilter(double min)
{
return new RankModifierFilter(min);
}
private static PObjectFilter createSchoolFilter(String school)
{
return new SchoolFilter(school);
}
private static PObjectFilter createSettingFilter(String setting)
{
return new SettingFilter(setting);
}
private static PObjectFilter createSizeFilter(int size)
{
return new SizeFilter(size);
}
private static PObjectFilter createSourceFilter(String source)
{
return new SourceFilter(source, SourceFilter.LOW);
}
private static PObjectFilter createSpellResistanceFilter(String sr)
{
return new SpellResistanceFilter(sr);
}
/*
* #################################################################
* classes tab factory methods
* #################################################################
*/
private static PObjectFilter createSpellTypeFilter(String type)
{
return new SpellTypeFilter(type);
}
private static PObjectFilter createStatFilter(String stat)
{
return new StatFilter(stat);
}
private static PObjectFilter createSubschoolFilter(String school)
{
return new SubschoolFilter(school);
}
private static PObjectFilter createTypeFilter(String type)
{
return new TypeFilter(type);
}
private static PObjectFilter createTypeFilter(String type, boolean capitalize)
{
return new TypeFilter(type, capitalize);
}
private static PObjectFilter createUntrainedSkillFilter()
{
return new UntrainedSkillFilter();
}
private static PObjectFilter createVirtualFeatFilter()
{
return new VirtualFeatFilter();
}
private static PObjectFilter createWeaponFilter(String type)
{
return new WeaponFilter(type);
}
/**
* restore custom filters
*
* <br>author: Thomas Behr
*
* @param parser the parser used to recreate the filter
* @param filterList the list in which to store the filter
* @param filterDefinitions a list with all the difining strings of the filters to recreate
*/
private static void parseCustomFilterList(FilterParser parser, List<PObjectFilter> filterList, List<String[]> filterDefinitions)
{
for ( final String[] filterData : filterDefinitions )
{
final StringBuffer filterDefinition = new StringBuffer();
// TODO - Create constant for this.
final StringTokenizer tokens = new StringTokenizer(filterData[0], "()", true); //$NON-NLS-1$
while (tokens.hasMoreTokens())
{
final String token = tokens.nextToken();
if (FilterParser.isLegalToken(token.trim()))
{
filterDefinition.append(token);
}
else
{
filterDefinition.append('[');
filterDefinition.append(token);
filterDefinition.append(']');
}
}
try
{
PObjectFilter filter = parser.parse(filterDefinition.toString());
if ((filterData[1] + filterData[2]).length() > 0)
{
filter = FilterFactory.createNamedFilter(filter, filterData[1], filterData[2]);
}
filterList.add(filter);
}
catch (FilterParseException ex)
{
//Shouldn't something more be done here?
Logging.errorPrintLocalised("Errors.FilterFactory.ParseError", ex); //$NON-NLS-1$
}
}
}
/**
* process filterString to determine into which list a filter shall be stored
* according to the previously saved filter settings
*
* <br>author: Thomas Behr 01-03-02
*
* @param list the list to store the newly restored filters
* @param filterString the property string from which the filters will be restored
*
* @return a list containing the definitions of yet to be restored custom filters
*/
private static List<String[]> preprocessFilterList(String list, String filterString)
{
List<String[]> customFilters = new ArrayList<String[]>();
if (filterString.length() == 0)
{
return customFilters;
}
// TODO - Make constants for this.
final StringTokenizer filterTokens = new StringTokenizer(filterString, "[]"); //$NON-NLS-1$
while (filterTokens.hasMoreTokens())
{
final StringTokenizer tokens = new StringTokenizer(filterTokens.nextToken(), Constants.PIPE);
final String className = tokens.nextToken();
final String classDef = tokens.nextToken();
final String filterName = (tokens.hasMoreTokens()) ? tokens.nextToken() : Constants.EMPTY_STRING;
final String filterDesc = (tokens.hasMoreTokens()) ? tokens.nextToken() : Constants.EMPTY_STRING;
/*
* case:
* custom filters, i.e.
* pcgen.gui.filter.CompoundFilter,
* pcgen.gui.filter.InverseFilter
* pcgen.gui.filter.NamedFilter
* since custom filters rely upon the standard filters,
* we need to have all standard filters restored before
* we restore the custom filters
*/
// TODO - This should be handled better.
if (className.endsWith("CompoundFilter") //$NON-NLS-1$
|| className.endsWith("InverseFilter") //$NON-NLS-1$
|| className.endsWith("NamedFilter")) //$NON-NLS-1$
{
customFilters.add(new String[]{ classDef, filterName, filterDesc });
}
/*
* case:
* standard filter
*/
else
{
filterSettings.put(classDef, list);
}
}
return customFilters;
}
}
final class PCClassFilter extends AbstractPObjectFilter
{
PCClassFilter()
{
super(PropertyFactory.getString("Filters.Category.Object"), PropertyFactory.getString("in_class")); //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
* @see pcgen.gui.filter.PObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof PCClass)
{
return true;
}
return false;
}
}
final class PCTemplateFilter extends AbstractPObjectFilter
{
PCTemplateFilter()
{
super(PropertyFactory.getString("Filters.Category.Object"), //$NON-NLS-1$
PropertyFactory.getString("in_template")); //$NON-NLS-1$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof PCTemplate)
{
return true;
}
return false;
}
}
final class RaceFilter extends AbstractPObjectFilter
{
RaceFilter()
{
super(PropertyFactory.getString("Filters.Category.Object"), //$NON-NLS-1$
PropertyFactory.getString("in_race")); //$NON-NLS-1$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Race)
{
return true;
}
return false;
}
}
/*
* #################################################################
* classes tab filters
* #################################################################
*/
final class SpellTypeFilter extends AbstractPObjectFilter
{
private String type;
SpellTypeFilter(final String aType)
{
super(PropertyFactory.getString("in_spellType"), aType); //$NON-NLS-1$
this.type = aType.toUpperCase();
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof PCClass)
{
return ((PCClass) pObject).getSpellType().toUpperCase().equals(type);
}
return true;
}
}
/*
* #################################################################
* domain tab filters
* #################################################################
*/
abstract class AlignmentFilter extends AbstractPObjectFilter
{
enum Mode {
/** Objects with this alignment are allowed */
ALLOWED("in_Filters.Mode.Allowed"), //$NON-NLS-1$
/** Objects with this alignment are required */
REQUIRED("in_Filters.Mode.Required"), //$NON-NLS-1$
/** Not sure */
DEFAULT("in_Filters.Mode.Default"); //$NON-NLS-1$
private String theName;
Mode(final String aResourceId)
{
theName = PropertyFactory.getString(aResourceId);
}
/**
* Returns the display name for this mode.
*
* @return A string to display for this mode.
*/
@Override
public String toString()
{
return theName;
}
}
/** The <tt>Mode</tt> for this filter */
protected Mode theMode;
/**
* Construct an AlignmentFilter with the specified category and name.
*
* @param argCategory The category.
* @param argName The name.
*/
protected AlignmentFilter(final String argCategory, final String argName)
{
super(argCategory, argName);
}
/**
* Tests to see if this Filter applies to this PObject.
*
* @param pObject The Object to test
* @param alignment The alignment index to test for
* @return <tt>true</tt> if the object passes.
*/
protected boolean passesAlignmentPrereqs(PObject pObject, int alignment)
{
StringBuffer prealign;
switch ( theMode )
{
case ALLOWED:
prealign = new StringBuffer("0"); //$NON-NLS-1$
for (int i = 1; i < SettingsHandler.getGame().getUnmodifiableAlignmentList().size(); i++)
{
prealign.append(Constants.COMMA).append(i);
}
break;
case REQUIRED:
prealign = new StringBuffer(Constants.EMPTY_STRING);
break;
default:
return false;
}
if (pObject.hasPrerequisites()) {
for (Prerequisite p : pObject.getPrerequisiteList()) {
// TODO - Fix prereqs to not use/give out strings.
if ("ALIGN".equalsIgnoreCase( p.getKind() )) //$NON-NLS-1$
{
prealign = new StringBuffer(p.getKey() );
break;
}
}
}
if (prealign.toString().indexOf(Integer.toString(alignment)) > -1)
{
return true;
}
return false;
}
}
final class DeityAlignmentFilter extends AlignmentFilter
{
private int alignment;
DeityAlignmentFilter(int anAlignment)
{
this(anAlignment, Mode.DEFAULT);
}
DeityAlignmentFilter(int anAlignment, Mode mode)
{
super(PropertyFactory.getString("in_alignLabel"), //$NON-NLS-1$
SettingsHandler.getGame().getLongAlignmentAtIndex(anAlignment));
this.alignment = anAlignment;
theMode = mode;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#getCategory()
*/
@Override
public String getCategory()
{
if ( theMode.equals(Mode.DEFAULT) )
{
return super.getCategory();
}
return super.getCategory() + " (" + theMode.toString() + ')'; //$NON-NLS-1$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Deity)
{
PCAlignment al = pObject.get(ObjectKey.ALIGNMENT);
String deityAlign = al == null ? "" : al.getKeyName();
if (deityAlign.equals(SettingsHandler.getGame().getShortAlignmentAtIndex(alignment))
|| deityAlign.equals(SettingsHandler.getGame().getLongAlignmentAtIndex(alignment)))
{
return true;
}
return false;
}
else if (pObject instanceof PCClass)
{
return passesAlignmentPrereqs(pObject);
}
else if (pObject instanceof PCTemplate)
{
return passesAlignmentPrereqs(pObject);
}
else if (pObject instanceof Race)
{
return passesAlignmentPrereqs(pObject);
}
return true;
}
private boolean passesAlignmentPrereqs(PObject pObject)
{
return passesAlignmentPrereqs(pObject, alignment);
}
}
final class DomainFilter extends AbstractPObjectFilter
{
private Domain domain;
DomainFilter(final Domain aDomain)
{
super(PropertyFactory.getString("in_domains"), aDomain.getDisplayName()); //$NON-NLS-1$
this.domain = aDomain;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if ((pObject == null) || (domain == null))
{
return false;
}
if (pObject instanceof Deity)
{
return ((Deity) pObject).hasObjectOnList(Deity.DOMAINLIST, domain);
}
else if (pObject instanceof Domain)
{
return true;
}
return true;
}
}
final class PantheonFilter extends AbstractPObjectFilter
{
enum Detail {
/** Provide a high level of detail */
HIGH,
/** Provide a lower level of detail */
LOW;
}
private String pantheon;
private Detail detailLevel;
PantheonFilter(final String aPantheon, Detail argDetailLevel)
{
super();
this.detailLevel = argDetailLevel;
this.pantheon = ((this.detailLevel == Detail.LOW) ? normalizePantheon(aPantheon) : aPantheon);
this.pantheon = ((this.pantheon.equalsIgnoreCase(Constants.LST_ALL)) ? Constants.LST_ALL : aPantheon);
setCategory(PropertyFactory.getString("in_pantheon") //$NON-NLS-1$
+ ((detailLevel == Detail.LOW)
? String.format("(%1$s)", PropertyFactory.getString("in_general")) //$NON-NLS-1$ //$NON-NLS-2$
: String.format("(%1$s)", PropertyFactory.getString("in_specific")))); //$NON-NLS-1$//$NON-NLS-2$
setName(this.pantheon);
setDescription((this.pantheon.equalsIgnoreCase(Constants.LST_ALL))
? PropertyFactory.getString("in_acceptPantAll") //$NON-NLS-1$
: PropertyFactory.getFormattedString("Filters.Pantheon.Description", pantheon)); //$NON-NLS-1$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Deity)
{
final Deity aDeity = (Deity) pObject;
if (pantheon.equals(Constants.LST_ALL) && (aDeity.getSafeListFor(ListKey.PANTHEON).size() == 0))
{
return true;
}
for ( final Pantheon pantheon : aDeity.getSafeListFor(ListKey.PANTHEON) )
{
String tmp = pantheon.toString();
if (detailLevel == Detail.LOW)
{
tmp = normalizePantheon(tmp);
}
if (pantheon.toString().startsWith(tmp))
{
return true;
}
}
return false;
}
return true;
}
/**
* see comments in GameFilter, regarding overriding private methods from the superclass - gorm
* @param s
* @return String
*/
private static String normalizePantheon(String s)
{
String work = s;
if (work.indexOf("(") > 0) //$NON-NLS-1$
{
work = (new StringTokenizer(work, "()")).nextToken().trim(); //$NON-NLS-1$
}
return work;
}
}
final class PCAlignmentFilter extends AlignmentFilter
{
PCAlignmentFilter()
{
this(Mode.DEFAULT);
}
PCAlignmentFilter(final Mode aMode)
{
super(PropertyFactory.getString("in_alignLabel"), PropertyFactory.getString("in_pc")); //$NON-NLS-1$//$NON-NLS-2$
theMode = aMode;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#getCategory()
*/
@Override
public String getCategory()
{
if (theMode.equals(Mode.DEFAULT))
{
return super.getCategory();
}
return super.getCategory() + " (" + theMode.toString() + ")"; //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* Returns the name of this filter.
*
* @see pcgen.gui.filter.AbstractPObjectFilter#getName(pcgen.core.PlayerCharacter)
*/
@Override
public String getName(PlayerCharacter aPC)
{
if (aPC != null)
{
return super.getName(aPC) + " (" //$NON-NLS-1$
+ SettingsHandler.getGame().getLongAlignmentAtIndex(aPC.getAlignment()) + ")"; //$NON-NLS-1$
}
return super.getName(aPC);
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(PlayerCharacter aPC, PObject pObject)
{
if (pObject == null)
{
return false;
}
int alignment = aPC.getAlignment();
if (pObject instanceof Deity)
{
PCAlignment al = pObject.get(ObjectKey.ALIGNMENT);
String deityAlign = al == null ? "" : al.getKeyName();
if (deityAlign.equals(SettingsHandler.getGame().getShortAlignmentAtIndex(alignment))
|| deityAlign.equals(SettingsHandler.getGame().getLongAlignmentAtIndex(alignment)))
{
return true;
}
return false;
}
else if (pObject instanceof PCClass)
{
return passesAlignmentPrereqs(pObject, alignment);
}
else if (pObject instanceof PCTemplate)
{
return passesAlignmentPrereqs(pObject, alignment);
}
else if (pObject instanceof Race)
{
return passesAlignmentPrereqs(pObject, alignment);
}
return true;
}
}
/*
* #################################################################
* feat tab filters
* #################################################################
*/
final class AutomaticFeatFilter extends AbstractPObjectFilter
{
AutomaticFeatFilter()
{
super(PropertyFactory.getString("in_feats"), PropertyFactory.getString("in_Automatic")); //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(PlayerCharacter aPC, PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Ability)
{
return aPC.hasFeatAutomatic(pObject.getKeyName());
}
return true;
}
}
final class NormalFeatFilter extends AbstractPObjectFilter
{
NormalFeatFilter()
{
super(PropertyFactory.getString("in_feats"), PropertyFactory.getString("in_Normal")); //$NON-NLS-1$//$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Ability)
{
return aPC.hasRealFeat((Ability)pObject);
}
return true;
}
}
/**
* <code>VirtualFeatFilter</code> is a filter object which allows
* through feats that are allocated as virtual feats to the PC.
*/
final class VirtualFeatFilter extends AbstractPObjectFilter
{
/**
* Create a new VirtualFeatFilter instance.
*/
VirtualFeatFilter()
{
super(PropertyFactory.getString("in_feats"), PropertyFactory.getString("in_Virtual")); //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.PObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(PlayerCharacter aPC, PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Ability)
{
return aPC.hasFeatVirtual(pObject.getKeyName());
}
return true;
}
}
/*
* #################################################################
* inventory tab filters
* #################################################################
*/
final class AffordableFilter extends AbstractPObjectFilter
{
AffordableFilter()
{
super(PropertyFactory.getString("in_miscel"), PropertyFactory.getString("in_Affordable")); //$NON-NLS-1$//$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Equipment)
{
// TODO - Should this check to see if ignore cost is on?
return ((Equipment) pObject).getCost(aPC).compareTo(aPC.getGold()) < 1;
}
return true;
}
}
final class NonMagicFilter extends AbstractPObjectFilter
{
NonMagicFilter()
{
super(PropertyFactory.getString("in_miscel"), PropertyFactory.getString("in_Non-Magic")); //$NON-NLS-1$//$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Equipment)
{
return !((Equipment) pObject).isMagic();
}
return true;
}
}
final class PCSizeFilter extends AbstractPObjectFilter
{
PCSizeFilter()
{
super(PropertyFactory.getString("in_size"), PropertyFactory.getString("PC")); //$NON-NLS-1$//$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#getName(pcgen.core.PlayerCharacter)
*/
@Override
public String getName(final PlayerCharacter aPC)
{
String pcName = super.getName(aPC);
if (aPC != null)
{
pcName += " ("; //$NON-NLS-1$
final SizeAdjustment sizeAdj = SettingsHandler.getGame().getSizeAdjustmentAtIndex(aPC.sizeInt());
if (sizeAdj != null)
{
pcName += sizeAdj.getDisplayName();
}
pcName += ')';
}
return pcName;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Equipment)
{
return ((Equipment) pObject).getSafe(ObjectKey.SIZE).equals(SettingsHandler.getGame().getSizeAdjustmentAtIndex(
aPC.sizeInt()));
}
return true;
}
}
final class TypeFilter extends AbstractPObjectFilter
{
private String type;
TypeFilter(final String argType)
{
this(argType, true);
}
TypeFilter(final String argType, final boolean capitalize)
{
super(PropertyFactory.getString("in_type"), //$NON-NLS-1$
(capitalize) ? CoreUtility.capitalizeFirstLetter(argType) : argType);
this.type = argType.toUpperCase();
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
// TODO - Should this just return isType() for any PObject?
if (pObject instanceof Equipment
|| pObject instanceof PCClass
|| pObject instanceof Race)
{
return pObject.isType(type);
}
return true;
}
}
final class WeaponFilter extends AbstractPObjectFilter
{
private String type;
WeaponFilter(final String argType)
{
super(PropertyFactory.getString("in_weapon"), //$NON-NLS-1$
CoreUtility.capitalizeFirstLetter(argType));
this.type = argType.toUpperCase();
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Equipment)
{
return (pObject).isType(type);
}
return true;
}
}
/*
* #################################################################
* skill tab filters
* #################################################################
*/
final class RankFilter extends AbstractPObjectFilter
{
private double min;
RankFilter(final double aMin)
{
super(PropertyFactory.getString("in_skills"), //$NON-NLS-1$
PropertyFactory.getFormattedString("Filters.Rank.Name", aMin)); //$NON-NLS-1$
this.min = aMin;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Skill)
{
/*
* since InfoSkills was revamped and the concept
* of displaying skills was changed,
* we have to break this clean design :-(
*
* author: Thomas Behr 21-03-02
*/
Skill aSkill = (Skill) pObject;
if (aPC.getSkillKeyed(aSkill.getKeyName()) != null)
{
aSkill = aPC.getSkillKeyed(aSkill.getKeyName());
}
return aSkill.getTotalRank(aPC).doubleValue() > min;
}
return true;
}
}
final class RankModifierFilter extends AbstractPObjectFilter
{
private double min;
RankModifierFilter(final double aMin)
{
super(PropertyFactory.getString("in_skills"), //$NON-NLS-1$
PropertyFactory.getFormattedString("Filters.RankMod.Name", aMin)); //$NON-NLS-1$
this.min = aMin;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Skill)
{
/*
* since InfoSkills was revamped and the concept
* of displaying skills was changed,
* we have to break this clean design :-(
*
* author: Thomas Behr 21-03-02
*/
Skill aSkill = (Skill) pObject;
if (aPC.getSkillKeyed(aSkill.getKeyName()) != null)
{
aSkill = aPC.getSkillKeyed(aSkill.getKeyName());
}
return (aSkill.getTotalRank(aPC).doubleValue() + SkillModifier.modifier(aSkill, aPC).doubleValue()) > min;
}
return true;
}
}
final class StatFilter extends AbstractPObjectFilter
{
StatFilter(final String stat)
{
super(PropertyFactory.getString("in_keyAbility"), stat.toUpperCase()); //$NON-NLS-1$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(final PlayerCharacter aPC, final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Skill)
{
return ((Skill) pObject).getKeyStatAbb().toUpperCase().equals(getName(aPC));
}
return true;
}
}
final class UntrainedSkillFilter extends AbstractPObjectFilter
{
UntrainedSkillFilter()
{
super(PropertyFactory.getString("in_skills"), PropertyFactory.getString("in_untrained")); //$NON-NLS-1$ //$NON-NLS-2$
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Skill)
{
return ((Skill) pObject).getSafe(ObjectKey.USE_UNTRAINED);
}
return true;
}
}
/*
* #################################################################
* spell tab filters
* #################################################################
*/
final class CastingTimeFilter extends AbstractPObjectFilter
{
private String castingTime;
CastingTimeFilter(final String argCastingTime)
{
super(PropertyFactory.getString("in_castingTime"), argCastingTime); //$NON-NLS-1$
castingTime = argCastingTime;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return ((Spell) pObject).getCastingTime().equals(castingTime);
}
return true;
}
}
final class ComponentFilter extends AbstractPObjectFilter
{
private String component;
ComponentFilter(String argComponent)
{
super(PropertyFactory.getString("in_component"), argComponent); //$NON-NLS-1$
this.component = argComponent;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
StringTokenizer tokens = new StringTokenizer(((Spell) pObject).getComponentList());
while (tokens.hasMoreTokens())
{
if (tokens.nextToken().equals(component))
{
return true;
}
}
return false;
}
return true;
}
}
final class DescriptorFilter extends AbstractPObjectFilter
{
private String descriptor;
DescriptorFilter(final String aDescriptor)
{
super(PropertyFactory.getString("in_descriptor"), aDescriptor); //$NON-NLS-1$
this.descriptor = aDescriptor;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return pObject.containsInList(ListKey.SPELL_DESCRIPTOR, descriptor);
}
return true;
}
}
final class EffectTypeFilter extends AbstractPObjectFilter
{
private String effectType;
EffectTypeFilter(final String anEffectType)
{
super(PropertyFactory.getString("in_effectType"), anEffectType); //$NON-NLS-1$
this.effectType = anEffectType;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return ((Spell) pObject).getTarget().equals(effectType);
}
return true;
}
}
final class RangeFilter extends AbstractPObjectFilter
{
private String range;
RangeFilter(final String aRange)
{
super();
this.range = aRange;
this.range = normalizeCategory(this.range);
this.range = normalizeRange(this.range);
setCategory(PropertyFactory.getString("in_range")); //$NON-NLS-1$
setName(this.range);
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return normalizeRange(((Spell) pObject).getRange()).indexOf(range) > -1;
}
return true;
}
/*
* removed internationalization here
*
* author: Thomas Behr 02-09-20
*/
private static String normalizeCategory(String s)
{
String work = s.trim().toUpperCase();
if (work.startsWith("CLOSE")) //$NON-NLS-1$
{
return "Close";
}
if (work.startsWith("MEDIUM")) //$NON-NLS-1$
{
return "Medium";
}
if (work.startsWith("LONG")) //$NON-NLS-1$
{
return "Long";
}
if (work.startsWith("PERSONAL")) //$NON-NLS-1$
{
return "Personal";
}
if (work.startsWith("TOUCH")) //$NON-NLS-1$
{
return "Touch";
}
return s;
}
/*
* removed internationalization here
* see comments in GameFilter - gorm
*
* author: Thomas Behr 02-09-20
*/
// TODO - This doesn't belong here. Move to spell code.
private static String normalizeRange(String s)
{
String work = s.trim();
String del;
StringBuffer buffer;
StringTokenizer tokens;
if ("SEE TEXT".equals(work.toUpperCase()))
{
return "See text";
}
int ftIndex = work.indexOf("ft");
int abbIndex = work.indexOf("'");
while ((ftIndex + abbIndex) > -2)
{
if (abbIndex > -1)
{
work = work.substring(0, abbIndex) + " feet" + work.substring(abbIndex + 1);
}
if (ftIndex > -1)
{
int length = 2;
if (work.indexOf("ft.") == ftIndex)
{
length = 3;
}
work = work.substring(0, ftIndex) + " feet" + work.substring(ftIndex + length);
}
ftIndex = work.indexOf("ft");
abbIndex = work.indexOf("'");
}
int plusIndex = work.indexOf("+");
del = Constants.EMPTY_STRING;
if (plusIndex > -1)
{
buffer = new StringBuffer();
tokens = new StringTokenizer(work, "+");
while (tokens.hasMoreTokens())
{
buffer.append(del).append(tokens.nextToken());
del = " + ";
}
work = buffer.toString();
}
int slashIndex = work.indexOf("/");
del = "";
if (slashIndex > -1)
{
buffer = new StringBuffer();
tokens = new StringTokenizer(work, "/");
while (tokens.hasMoreTokens())
{
buffer.append(del).append(tokens.nextToken());
del = " / ";
}
work = buffer.toString();
}
int lvlIndex = work.indexOf("lvl");
while (lvlIndex > -1)
{
work = work.substring(0, lvlIndex) + "level" + work.substring(lvlIndex + 3);
lvlIndex = work.indexOf("lvl");
}
int touchIndex = work.indexOf("touch");
if (touchIndex > -1)
{
buffer = new StringBuffer();
tokens = new StringTokenizer(work, " ", true);
String tokenNew;
while (tokens.hasMoreTokens())
{
tokenNew = tokens.nextToken();
if ("touch".equals(tokenNew))
{
tokenNew = "Touch";
}
buffer.append(tokenNew);
}
work = buffer.toString();
}
// change " " to " "
if (work.length() > 0)
{
buffer = new StringBuffer();
tokens = new StringTokenizer(work);
while (tokens.hasMoreTokens())
{
buffer.append(tokens.nextToken()).append(" ");
}
work = buffer.toString().trim();
}
return work;
}
}
final class SchoolFilter extends AbstractPObjectFilter
{
private String school;
SchoolFilter(final String aSchool)
{
super(PropertyFactory.getString("in_school"), aSchool); //$NON-NLS-1$
this.school = aSchool;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return ((Spell) pObject).getSchool().equals(school);
}
return true;
}
}
final class SpellResistanceFilter extends AbstractPObjectFilter
{
private String sr;
SpellResistanceFilter(final String anSR)
{
super();
this.sr = normalizeSpellResistance(anSR);
setCategory(PropertyFactory.getString("in_spellRes")); //$NON-NLS-1$
setName(this.sr);
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return ((Spell) pObject).getSpellResistance().indexOf(sr) > -1;
}
return true;
}
/*
* removed internationalization here
*
* author: Thomas Behr 02-09-20
*/
private static String normalizeSpellResistance(final String s)
{
String work = s.trim().toUpperCase();
if (work.startsWith("YES"))
{
return "Yes";
}
if (work.startsWith("NO"))
{
return "No";
}
return s;
}
}
final class SubschoolFilter extends AbstractPObjectFilter
{
private String school;
SubschoolFilter(final String aSchool)
{
super();
this.school = normalizeSubschool(aSchool);
setCategory(PropertyFactory.getString("in_subschool")); //$NON-NLS-1$
setName(this.school);
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Spell)
{
return normalizeSubschool(((Spell) pObject).getSubschool()).equals(school);
}
return true;
}
/*
* removed internationalization here
*
* author: Thomas Behr 02-09-20
*/
private static String normalizeSubschool(String s)
{
String work = s.trim().toUpperCase();
if ("NO".equals(work) || "NONE".equals(work))
{
return "None";
}
return s.trim();
}
}
/*
* #################################################################
* stats tab filters
* #################################################################
*/
final class FavoredClassFilter extends AbstractPObjectFilter
{
private String className;
FavoredClassFilter(final String aClassName)
{
super(PropertyFactory.getString("in_favoredClass"), aClassName); //$NON-NLS-1$
this.className = aClassName.toUpperCase();
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Race)
{
List<CDOMReference<? extends PCClass>> favClass = pObject
.getListFor(ListKey.FAVORED_CLASS);
/*
* CONSIDER Given SubClass issues, this is probably wrong
*/
for (CDOMReference<? extends PCClass> ref : favClass)
{
for (PCClass cl : ref.getContainedObjects())
{
if (cl.getKeyName().equalsIgnoreCase(className))
{
return true;
}
}
}
return false;
}
return true;
}
}
final class SizeFilter extends AbstractPObjectFilter
{
private int size;
SizeFilter(final int aSize)
{
super(PropertyFactory.getString("in_size"), SettingsHandler.getGame().getSizeAdjustmentAtIndex(aSize).getDisplayName()); //$NON-NLS-1$
this.size = aSize;
}
/**
* @see pcgen.gui.filter.AbstractPObjectFilter#accept(pcgen.core.PlayerCharacter, pcgen.core.PObject)
*/
@Override
public boolean accept(@SuppressWarnings("unused")final PlayerCharacter aPC,
final PObject pObject)
{
if (pObject == null)
{
return false;
}
if (pObject instanceof Equipment)
{
return ((Equipment) pObject).getSafe(ObjectKey.SIZE).equals(
SettingsHandler.getGame().getSizeAdjustmentAtIndex(size));
}
else if (pObject instanceof Race)
{
Formula sz = pObject.get(FormulaKey.SIZE);
final String aRaceSize = sz == null ? "" : sz.toString();
return aRaceSize.equals(SettingsHandler.getGame().getSizeAdjustmentAtIndex(size).getAbbreviation())
|| aRaceSize.equals(SettingsHandler.getGame().getSizeAdjustmentAtIndex(size).getDisplayName());
}
return true;
}
}
The table below shows all metrics for FilterFactory.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 313.00 | Number of blocks | |
| BLOCK_COMMENT | 178.00 | Number of block comment lines | |
| COMMENTS | 442.00 | Comment lines | |
| COMMENT_DENSITY | 0.46 | Comment density | |
| COMPARISONS | 154.00 | Number of comparison operators | |
| CYCLOMATIC | 299.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 85.00 | Comments in declarations | |
| DOC_COMMENT | 237.00 | Number of javadoc comment lines | |
| ELOC | 969.00 | Effective lines of code | |
| EXEC_COMMENTS | 29.00 | Comments in executable code | |
| EXITS | 181.00 | Procedure exits | |
| FUNCTIONS | 134.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 105.46 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 376.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 | 1.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 1.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 4.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 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 34.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 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 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 3.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 3813.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 | 5.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.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 | 1.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 | 2487.00 | Number of lines in the source file | |
| LINE_COMMENT | 27.00 | Number of line comments | |
| LOC | 1662.00 | Lines of code | |
| LOGICAL_LINES | 540.00 | Number of statements | |
| LOOPS | 15.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 2910.00 | Number of operands | |
| OPERATORS | 6000.00 | Number of operators | |
| PARAMS | 152.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 8910.00 | Halstead program length | |
| PROGRAM_VOCAB | 873.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 224.00 | Number of return points from functions | |
| SIZE | 60891.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 814.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 59.00 | Number of unique operators | |
| WHITESPACE | 383.00 | Number of whitespace lines | |