AbilityUtilities.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.

MetricDescription
DECL_COMMENTSComments in declarations
LINE_COMMENTNumber of line comments
COMMENTSComment lines
LINESNumber of lines in the source file
SIZESize of the file in bytes
PARAMSNumber of formal parameter declarations
CYCLOMATICCyclomatic complexity
EXEC_COMMENTSComments in executable code
DOC_COMMENTNumber of javadoc comment lines
COMPARISONSNumber of comparison operators
EXITSProcedure exits
LOCLines of code
BLOCKSNumber of blocks
JAVA0145JAVA0145 Tab character used in source file
OPERATORSNumber of operators
INTERFACE_COMPLEXITYInterface complexity
PROGRAM_LENGTHHalstead program length
OPERANDSNumber of operands
ELOCEffective lines of code
JAVA0034JAVA0034 Missing braces in if statement
UNIQUE_OPERANDSNumber of unique operands
PROGRAM_VOCABHalstead program vocabulary
NEST_DEPTHMaximum nesting depth
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
LOGICAL_LINESNumber of statements
WHITESPACENumber of whitespace lines
JAVA0144JAVA0144 Line exceeds maximum M characters
RETURNSNumber of return points from functions
PROGRAM_VOLUMEHalstead program volume
JAVA0136JAVA0136 N methods defined in class (maximum: M)
JAVA0138JAVA0138 N parameters defined for method (maximum: M)
UNIQUE_OPERATORSNumber of unique operators
JAVA0126JAVA0126 Method declares unchecked exception in throws
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
LOOPSNumber of loops
/* * AbilityUtilities.java * Copyright 2001 (C) Bryan McRoberts <merton_monk@yahoo.com> * * 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 Aug 25, 2005 * Refactored from PlayerCharacter, created on April 21, 2001, 2:15 PM * * */ package pcgen.core; import pcgen.cdom.base.CDOMReference; import pcgen.cdom.base.TransitionChoice; import pcgen.cdom.enumeration.ListKey; import pcgen.cdom.enumeration.ObjectKey; import pcgen.core.pclevelinfo.PCLevelInfo; import pcgen.core.utils.CoreUtility; import pcgen.util.Logging; import java.math.BigDecimal; import java.util.*; /** * General utilities related to the Ability class. * * @author Bryan McRoberts <merton_monk@users.sourceforge.net> * @version $Revision: 7367 $ */ public class AbilityUtilities { private AbilityUtilities () { // private constructor, do nothing } /** * Add the choices in the List to the ability if it is legal to do so. * * @param ability Ability to add the choices to * @param choices the iterable collection of choices to add */ private static void addChoicesToAbility( final Ability ability, final Iterable<String> choices) { for ( final String choice : choices ) { if (ability.canAddAssociation(choice)) { ability.addAssociated(choice); } } } /** * Clone anAbility, apply choices and add it to the addList, provided the * Ability allows it (if not isMultiples check if it's already there before * adding it). * * @param anAbility * @param choices * @param addList * @return the Ability added, or null if Ability was not added to the list. */ public static Ability addCloneOfAbilityToListwithChoices( final Ability anAbility, final List<String> choices, final List<Ability> addList) { Ability newAbility = null; /* * TODO I believe this is a bug, but need to check. This implies that anything * that is MULT:YES and is added virtually is added without cause for whether it stacks * - thpr Jul 24 08 */ if (anAbility != null && (anAbility.getSafe(ObjectKey.MULTIPLE_ALLOWED) || getAbilityFromList(addList, anAbility) == null)) { newAbility = anAbility.clone(); if (choices != null) { addChoicesToAbility(newAbility, choices); } addList.add(newAbility); } return newAbility; } /** * Search the List passed in for an instance of the Ability matching * category and Ability name. If we don't find it, attempt to locate * it in global Storage and, if it's there, clone it and add it the List. * If we got an ability, then add any sub choices from the name to the * associated list of the ability. * * @param theAbilityList A list of abilities to add to * @param category The category of Ability to add * @param abilityName The name of the Ability to Add * * @return The Ability processed */ public static Ability addCloneOfGlobalAbilityToListWithChoices( final List<Ability> theAbilityList, final String category, final String abilityName) { final Collection<String> choices = new ArrayList<String>(); getUndecoratedName(abilityName, choices); Ability anAbility = getAbilityFromList(theAbilityList, "FEAT", abilityName, Ability.Nature.ANY); if (anAbility == null) { anAbility = cloneGlobalAbility(category, abilityName); if (anAbility != null) { theAbilityList.add(anAbility); } } if (anAbility != null) { addChoicesToAbility(anAbility, choices); } return anAbility; } public static Ability addCloneOfGlobalAbilityToListWithChoices( final List<Ability> anAbilityList, final AbilityCategory aCategory, final String aKey) { final Collection<String> choices = new ArrayList<String>(); getUndecoratedName(aKey, choices); Ability anAbility = getAbilityFromList(anAbilityList, aCategory.getAbilityCategory(), aKey, Ability.Nature.ANY); if (anAbility == null) { anAbility = cloneGlobalAbility(aCategory.getAbilityCategory(), aKey); if (anAbility != null) { anAbilityList.add(anAbility); } } if (anAbility != null) { addChoicesToAbility(anAbility, choices); } return anAbility; } /** * Add a virtual feat to the character and include it in the List. * * @param anAbility * @param choices * @param addList * @param levelInfo * @return the Ability added */ public static Ability addVirtualAbility( final Ability anAbility, final List<String> choices, final List<Ability> addList, final PCLevelInfo levelInfo) { if (anAbility == null) { return null; } final Ability newAbility = addCloneOfAbilityToListwithChoices(anAbility, choices, addList); if (newAbility != null) { newAbility.setFeatType(Ability.Nature.VIRTUAL); newAbility.clearPrerequisiteList(); if (levelInfo != null) { levelInfo.addObject(newAbility); } } return newAbility; } /** * Add a virtual Ability to abilityList by category and name. Any choices made * (by including in parenthesis e.g. "Weapon Focus (Longsword)", are extracted * from the name and added appropriately * * @param category * @param aFeatKey * @param abilityList * @param levelInfo * * @return the Ability added */ public static Ability addVirtualAbility( final String category, final String aFeatKey, final List<Ability> abilityList, final PCLevelInfo levelInfo) { final List<String> choices = new ArrayList<String>(); final String abilityKey = getUndecoratedName(aFeatKey, choices); final Ability anAbility = Globals.getAbilityKeyed(category, abilityKey); return addVirtualAbility(anAbility, choices, abilityList, levelInfo); } /** * Do the Categorisable objects passed in represent the same ability? * * @param first * @param second * @return true if the same object is represented */ public static boolean areSameAbility( final Categorisable first, final Categorisable second) { if (first == null || second == null) { return false; } final boolean multFirst = getIsMultiples(first); final boolean multSecond = getIsMultiples(second); boolean nameCheck = false; if (multFirst && multSecond) { /* * The are both Multiply applicable, so strip the decorations (parts * in brackets) from the name, then check the undecorated names are * equal. */ final Collection<String> decorationsThis = new ArrayList<String>(); final Collection<String> decorationsThat = new ArrayList<String>(); final String undecoratedThis = getUndecoratedName(first.getKeyName(), decorationsThis); final String undecoratedThat = getUndecoratedName(second.getKeyName(), decorationsThat); nameCheck = undecoratedThis.compareToIgnoreCase(undecoratedThat) == 0; } else if (multFirst || multSecond) { // one is multiply applicable but the other isn't. They can't be the // same Ability return false; } else { /* * They're not multiply selectable, so anything in brackets isn't a * choice, it's part of the name */ nameCheck = first.getKeyName().compareToIgnoreCase(second.getKeyName()) == 0; } return (nameCheck && first.getCategory().compareToIgnoreCase(second.getCategory()) == 0); } /** * Do the Categorisable object and the string passed in represent the * same ability? the string is assumed to be in the same Category as the * Categorisable object. * * @param first * @param second * @return true if the same object is represented */ public static boolean areSameAbility( final Categorisable first, final String second) { if (first == null || second == null) { return false; } final Categorisable newSecond = new AbilityInfo(first.getCategory(), second); return areSameAbility(first, newSecond); } /** * If an ability in Global storage matches the category and name passed * in, then return a clone of that Ability. * * @param category * @param anAbilityKey * * @return a clone of a global ability */ private static Ability cloneGlobalAbility( final String category, final String anAbilityKey) { final Collection<String> choices = new ArrayList<String>(); final String baseKey = getUndecoratedName(anAbilityKey, choices); Ability anAbility = Globals.getAbilityKeyed(category, anAbilityKey); if ((anAbility == null) && (baseKey.length() != 0)) { anAbility = Globals.getAbilityKeyed(category, baseKey); } if (anAbility == null) { Logging.errorPrint("Attempted to add unknown Ability (" + category + "): " + anAbilityKey); } else { anAbility = anAbility.clone(); if (choices.size() > 0) { addChoicesToAbility(anAbility, choices); } } return anAbility; } /** * Finishes off the processing necessary to add or remove an Ability to/from * a PC. modFeat or modAbility have identified the Ability (either one * already owned by the PC, or a clone of the Globals copy. They have added * the Ability to the character, this method ensures that all necessary * adjustments (choices to add etc.) are made. * * @param ability * @param choice * @param aPC * @param addIt * @param singleChoice * @param category The AbilityCategory to add or remove the ability from. * @return 1 if adding the Ability, or 0 if removing it. */ public static int finaliseAbility( final Ability ability, final String choice, final PlayerCharacter aPC, final boolean addIt, final boolean singleChoice, final AbilityCategory category) { // how many sub-choices to make double abilityCount = (ability.getAssociatedCount() * ability.getSafe(ObjectKey.SELECTION_COST).doubleValue()); boolean adjustedAbilityPool = false; // adjust the associated List if (singleChoice && (addIt || ability.getSafe(ObjectKey.MULTIPLE_ALLOWED))) { if ("".equals(choice) || choice == null) { // Get modChoices to adjust the associated list and Feat Pool adjustedAbilityPool = ability.modChoices(aPC, addIt, category); } else if (addIt) { if (ability.canAddAssociation(choice)) { ability.addAssociated(choice); } } else { ability.removeAssociated(choice); } } /* * This modifyChoice method is a bit like mod choices, but it uses a * different tag to set the chooser string. The Tag MODIFYABILITYCHOICE * which doesn't appear to be used anywhere, so this code is totally * redundant. */ ability.modifyChoice(aPC); if (addIt) { for (TransitionChoice<Kit> kit : ability.getSafeListFor(ListKey.KIT_CHOICE)) { kit.act(kit.driveChoice(aPC), aPC); } } // if no sub choices made (i.e. all of them removed in Chooser box), // then remove the Feat boolean removed = false; boolean result = (ability.getSafe(ObjectKey.MULTIPLE_ALLOWED) && singleChoice) ? (ability.getAssociatedCount() > 0) : addIt ; if (! result) { removed = aPC.removeRealAbility(category, ability); aPC.removeNaturalWeapons(ability); aPC.removeTemplatesFrom(ability); ability.subAddsForLevel(-9, aPC); } if (singleChoice && !adjustedAbilityPool) { if (!addIt && !ability.getSafe(ObjectKey.MULTIPLE_ALLOWED) && removed) { // We don't need to adjust the pool for abilities here as it is recalculated each time it is queried. if (category == AbilityCategory.FEAT) { abilityCount += ability.getSafe(ObjectKey.SELECTION_COST).doubleValue(); } } else if (addIt && !ability.getSafe(ObjectKey.MULTIPLE_ALLOWED)) { abilityCount -= ability.getSafe(ObjectKey.SELECTION_COST).doubleValue(); } else if (category == AbilityCategory.FEAT) { int listSize = ability.getAssociatedCount(); for (Ability myAbility : aPC.getRealAbilitiesList(AbilityCategory.FEAT)) { if (myAbility.getKeyName().equalsIgnoreCase(ability.getKeyName())) { listSize = myAbility.getAssociatedCount(); } } abilityCount -= (listSize * ability.getSafe(ObjectKey.SELECTION_COST).doubleValue()); } if (category == AbilityCategory.FEAT) { aPC.adjustAbilities(category, BigDecimal.valueOf(abilityCount)); } } aPC.setAutomaticAbilitiesStable(null, false); aPC.adjustMoveRates(); if (addIt && !aPC.isImporting()) { ability.globalChecks(false, aPC); ability.checkRemovals(aPC); } return result ? 1 : 0; } /** * Find an ability in a list that matches a given Ability or AbilityInfo * Object. * * @param anAbilityList * @param abilityInfo * * @return the Ability if found, otherwise null */ public static Ability getAbilityFromList( final List<Ability> anAbilityList, final Categorisable abilityInfo) { return getAbilityFromList(anAbilityList, abilityInfo, Ability.Nature.ANY); } /** * Find an ability in a list that matches a given Ability or AbilityInfo * Object. Also takes an integer representing a type, -1 always matches, * otherwise an ability will only be returned if its type is the same as * abilityType * * @param anAbilityList * @param abilityInfo * @param abilityType * * @return the Ability if found, otherwise null */ public static Ability getAbilityFromList( final List<Ability> anAbilityList, final Categorisable abilityInfo, final Ability.Nature abilityType) { for ( Ability ability : anAbilityList ) { if (AbilityUtilities.areSameAbility(ability, abilityInfo) && ((abilityType == Ability.Nature.ANY) || (ability.getFeatType() == abilityType))) { return ability; } } return null; } /** * Find an ability in a list that matches a given AbilityInfo Object. Also * takes an integer representing a type, -1 always matches, otherwise an * ability will only be returned if its type is the same as abilityType * * @param anAbilityList * @param aCat * @param aName * @param abilityType * * @return the Ability if found, otherwise null */ public static Ability getAbilityFromList( final List<Ability> anAbilityList, final String aCat, final String aName, final Ability.Nature abilityType) { final AbilityInfo abInfo = new AbilityInfo(aCat, aName); return getAbilityFromList(anAbilityList, abInfo, abilityType); } /** * Find out if this Categorisable Object can be applied to a character * multiple times * * @param aCatObj * @return true if can be applied multiple times */ private static boolean getIsMultiples( final Categorisable aCatObj) { if (aCatObj instanceof Ability) { return ((Ability) aCatObj).getSafe(ObjectKey.MULTIPLE_ALLOWED); } else if (aCatObj instanceof AbilityInfo) { final Ability ability = ((AbilityInfo) aCatObj).getAbility(); if (ability == null) { return false; } return ability.getSafe(ObjectKey.MULTIPLE_ALLOWED); } return false; } /** * Add an Ability to a character, allowing sub-choices if necessary. Always adds * weapon proficiencies, either a single choice if addAll is false, or all * possible choices if addAll is true. * @param aPC the PC to add or remove the Feat from * @param levelInfo LevelInfo object to adjust. * @param argAbility The ability to process * @param choice For an isMultiples() Ability * @param create false means the character must already have the Ability (which * only makes sense if it allows multiples); true means a new * instance of the global Ability will be cloned and added to the * character as a real Ability (this is the only way to add real * non-virtual Ability objects). * @param category The AbilityCategory to add or remove the ability from. * @return 1 if adding the Ability or 0 if removing it. */ public static int modAbility( final PlayerCharacter aPC, final PCLevelInfo levelInfo, final Ability argAbility, final String choice, final boolean create, final AbilityCategory category) { if (argAbility == null) { Logging.errorPrint("Can't process null Ability"); return create ? 1 : 0; } if (aPC.isNotImporting()) {aPC.getSpellList();} final List<Ability> realAbilities = aPC.getRealAbilitiesList(category); Ability pcAbility = getAbilityFromList(realAbilities, argAbility); // (pcAbility == null) means we don't have this feat, // so we need to add it if (create && (pcAbility == null)) { // adding feat for first time pcAbility = argAbility.clone(); aPC.addAbility(category, pcAbility, levelInfo); aPC.selectTemplates(pcAbility, aPC.isImporting()); } if (pcAbility == null) { Logging.errorPrint("Can't process ability " + argAbility + " not present in character."); return create ? 1 : 0; } return finaliseAbility(pcAbility, choice, aPC, create, true, category); } /** * Add a Feat to a character, allowing sub-choices if necessary. Always adds * weapon proficiencies, either a single choice if singleChoice is true, or all * possible choices if singleChoice is false. * * @param aPC the PC to add or remove the Feat from * @param LevelInfo * @param aFeatKey the name of the Feat to add. * @param addIt false means the character must already have the * feat (which only makes sense if it * allows multiples); true means * to add the feat (the only way to add * new feats). * @param singleChoice false means allow sub-choices; true means no sub-choices. * * @return 1 if adding the Ability but it wasn't there or 0 if the PC does * not currently have the Ability. */ public static int modFeat( final PlayerCharacter aPC, final PCLevelInfo LevelInfo, final String aFeatKey, final boolean addIt, final boolean singleChoice) { boolean singleChoice1 = !singleChoice; if (!aPC.isImporting()) { aPC.getSpellList(); } final Collection<String> choices = new ArrayList<String>(); final String baseKey = getUndecoratedName(aFeatKey, choices); String subKey = choices.size() > 0 ? choices.iterator().next() : ""; // See if our choice is not auto or virtual Ability anAbility = aPC.getRealFeatKeyed(aFeatKey); // if a feat keyed aFeatKey doesn't exist, and aFeatKey // contains a (blah) descriptor, try removing it. if (anAbility == null) { anAbility = aPC.getRealFeatKeyed(baseKey); if (!singleChoice1 && (anAbility != null) && (subKey.length() != 0)) { singleChoice1 = true; } } // (anAbility == null) means we don't have this feat, so we need to add it if ((anAbility == null) && addIt) { // Adding feat for first time anAbility = Globals.getAbilityKeyed("FEAT", baseKey); if (anAbility == null) { anAbility = Globals.getAbilityKeyed("FEAT", aFeatKey); if (anAbility != null) { subKey = ""; } } if (anAbility == null) { Logging.errorPrint("Feat not found: " + aFeatKey); return 1; } anAbility = anAbility.clone(); aPC.addFeat(anAbility, LevelInfo); aPC.selectTemplates(anAbility, aPC.isImporting()); } /* * Could not find the Ability: addIt true means that no global Ability called * featName exists, addIt false means that the PC does not have this ability */ if (anAbility == null) { return addIt ? 1 : 0; } return finaliseAbility(anAbility, subKey, aPC, addIt, singleChoice1, AbilityCategory.FEAT); } /** * Add multiple feats from a String list separated by commas. * @param aPC * @param LevelInfo * @param aList * @param addIt * @param all */ static void modFeatsFromList( final PlayerCharacter aPC, final PCLevelInfo LevelInfo, final String aList, final boolean addIt, final boolean all) { final StringTokenizer aTok = new StringTokenizer(aList, ","); while (aTok.hasMoreTokens()) { String aString = aTok.nextToken(); Ability anAbility = aPC.getFeatNamed(aString); StringTokenizer bTok = null; if (anAbility != null) { continue; } // Get ability from global storage by Name anAbility = Globals.getAbilityKeyed("FEAT", aString); if (anAbility == null) { // could not find Feat, try trimming off contents of parenthesis bTok = new StringTokenizer(aString, "()", true); final String bString = bTok.nextToken(); final int beginIndex = bString.length() + 1; final int endIndex = aString.lastIndexOf(')'); if (beginIndex <= aString.length()) { if (endIndex >= beginIndex) { bTok = new StringTokenizer(aString.substring(beginIndex, endIndex), ","); } else { bTok = new StringTokenizer(aString.substring(beginIndex), ","); } } else { bTok = null; } aString = bString.replace('(', ' ').replace(')', ' ').trim(); } else { final Ability tempAbility = aPC.getFeatKeyed(anAbility.getKeyName()); if (tempAbility != null) { anAbility = tempAbility; } else { // add the Feat found, as a CharacterFeat anAbility = anAbility.clone(); aPC.addFeat(anAbility, LevelInfo); } } if (anAbility == null) { // if we still haven't found it, try a different string if (!addIt) { return; } anAbility = Globals.getAbilityKeyed("FEAT", aString); if (anAbility == null) { Logging.errorPrint("Feat not found in PlayerCharacter.modFeatsFromList: " + aString); return; } anAbility = anAbility.clone(); aPC.addFeat(anAbility, LevelInfo); } if ((bTok != null) && bTok.hasMoreTokens()) { while (bTok.hasMoreTokens()) { aString = bTok.nextToken(); if ("DEITYWEAPON".equals(aString)) { if (aPC.getDeity() != null) { List<CDOMReference<WeaponProf>> dwp = aPC .getDeity().getSafeListFor(ListKey.DEITYWEAPON); for (CDOMReference<WeaponProf> ref : dwp) { for (WeaponProf wp : ref.getContainedObjects()) { if (addIt) { anAbility.addAssociated(wp.getKeyName()); } else { anAbility.removeAssociated(wp.getKeyName()); } } } } } else { if (addIt) { anAbility.addAssociated(aString); } else { anAbility.removeAssociated(aString); } } } } else { if (!all && !anAbility.getSafe(ObjectKey.MULTIPLE_ALLOWED)) { if (addIt) { aPC.adjustFeats(anAbility.getSafe(ObjectKey.SELECTION_COST).doubleValue()); } else { aPC.adjustFeats(-anAbility.getSafe(ObjectKey.SELECTION_COST).doubleValue()); } } modFeat(aPC, LevelInfo, aString, addIt, all); } } aPC.setAutomaticAbilitiesStable(null, false); // aPC.setAutomaticFeatsStable(false); } /** * Build and return a list of the Ability objects associated with the given * PlayerCharacter object * @param aPc * * @return a List of the Abilities this Character has */ // static public List<Ability> rebuildAutoAbilityList(PlayerCharacter aPc) // { // final List<Ability> autoFeatList; // autoFeatList = new ArrayList<Ability>(); // // // // // add racial feats // // // if ((aPc.getRace() != null) && !PlayerCharacterUtilities.canReassignRacialFeats()) // { // final StringTokenizer aTok = new StringTokenizer(aPc.getRace().getFeatList(aPc), Constants.PIPE); // // while (aTok.hasMoreTokens()) // { // Ability added = addCloneOfGlobalAbilityToListWithChoices(autoFeatList, Constants.FEAT_CATEGORY, aTok.nextToken()); // if ( added != null ) // { // added.setFeatType(Ability.Nature.AUTOMATIC); // } // } // } // // for (PCClass aClass : aPc.getClassList()) // { // for (Iterator<String> e1 = aClass.getFeatAutos().iterator(); e1.hasNext();) // { // // // // PCClass object have auto feats stored in format: // // lvl|feat_name // // // final String aString = e1.next(); // // if (aString.indexOf('|') < 1) // { // continue; // } // // final StringTokenizer aTok = new StringTokenizer(aString, "|"); // int i; // // try // { // i = Integer.parseInt(aTok.nextToken()); // } // catch (NumberFormatException exc) // { // continue; // } // // if (i > aClass.getLevel()) // { // continue; // } // // String autoFeat = aTok.nextToken(); // final int idx = autoFeat.indexOf('['); // // if (idx >= 0) // { // final StringTokenizer bTok = new StringTokenizer(autoFeat.substring(idx + 1), "[]"); // final List<Prerequisite> preReqList = new ArrayList<Prerequisite>(); // // while (bTok.hasMoreTokens()) // { // final String prereqString = bTok.nextToken(); // Logging.debugPrint("Why is the prerequisite '"+prereqString+ // "' parsed in PlayerCharacter.featAutoList() rather than the persistence layer"); // try { // final PreParserFactory factory = PreParserFactory.getInstance(); // final Prerequisite prereq = factory.parse(prereqString); // preReqList.add(prereq); // } // catch (PersistenceLayerException ple){ // Logging.errorPrint(ple.getMessage(), ple); // } // } // // autoFeat = autoFeat.substring(0, idx); // // if (preReqList.size() != 0) // { // // // // To avoid possible infinite loop // // // if (!aPc.isAutomaticFeatsStable()) // { // aPc.setStableAutomaticFeatList(autoFeatList); // } // // if (! PrereqHandler.passesAll(preReqList, aPc, null )) // { // continue; // } // } // } // // Ability added = addCloneOfGlobalAbilityToListWithChoices(autoFeatList, "FEAT", autoFeat); // if ( added != null ) // { // added.setFeatType(Ability.Nature.AUTOMATIC); // } // } // } // // if (!PlayerCharacterUtilities.canReassignTemplateFeats() && !aPc.getTemplateList().isEmpty()) // { // for (PCTemplate aTemplate : aPc.getTemplateList()) // { // aPc.setStableAutomaticFeatList(autoFeatList); // final List<String> templateFeats = aTemplate.feats(aPc.getTotalLevels(), aPc.totalHitDice(), aPc, false); // // if (!templateFeats.isEmpty()) // { // for (Iterator<String> e2 = templateFeats.iterator(); e2.hasNext();) // { // final String aString = e2.next(); // final StringTokenizer aTok = new StringTokenizer(aString, ","); // // while (aTok.hasMoreTokens()) // { // Ability added = addCloneOfGlobalAbilityToListWithChoices(autoFeatList, "FEAT", aTok.nextToken()); // if ( added != null ) // { // added.setFeatType(Ability.Nature.AUTOMATIC); // } // } // } // } // } // } // // if (!aPc.getCharacterDomainList().isEmpty()) // { // for (CharacterDomain aCD : aPc.getCharacterDomainList()) // { // final Domain aDomain = aCD.getDomain(); // // if (aDomain != null) // { // for (int e2 = 0; e2 < aDomain.getAssociatedCount(); ++e2) // { // final String aString = aDomain.getAssociated(e2); // // if (aString.startsWith("FEAT")) // { // final int idx = aString.indexOf('?'); // // if (idx > -1) // { // Ability added = addCloneOfGlobalAbilityToListWithChoices(autoFeatList, "FEAT", aString.substring(idx + 1)); // if ( added != null ) // { // added.setFeatType(Ability.Nature.AUTOMATIC); // } // } // else // { // Logging.errorPrint("no '?' in Domain assocatedList entry: " + aString); // } // } // } // // final Iterator<Categorisable> anIt = aDomain.getFeatIterator(); // // for (; anIt.hasNext();) // { // final Ability abI = (Ability)anIt.next(); // Ability added = addCloneOfGlobalAbilityToListWithChoices(autoFeatList, "FEAT", abI.getKeyName()); // if ( added != null ) // { // added.setFeatType(Ability.Nature.AUTOMATIC); // } // } // } // } // } // //// aPc.setStableAutomaticFeatList(autoFeatList); // return autoFeatList; // } /** * This method attempts to get an Ability Object from the Global Store keyed * by token. If this fails, it checks if token has info in parenthesis * appended to it. If it does, it strips this and attempts to get an * Ability Keyed by the stripped token. If this works, it passes back this * Ability, if it does not work, it returns null. * * @param cat The category of Ability Object to retrieve * @param token The name of the Ability Object * * @return The ability in category "cat" called "token" */ public static Ability retrieveAbilityKeyed( final String cat, final String token) { AbilityCategory aCat = AbilityUtilities.getAbilityCategory(cat); Ability ability = Globals.getAbilityKeyed(aCat, token); if (ability != null) { return ability; } final String stripped = removeChoicesFromName(token); ability = Globals.getAbilityKeyed(aCat, stripped); if (ability != null) { return ability; } return null; } /** * Convenience method to retrieve an <tt>AbilityCategory</tt> by * its key name. * * @param aKey The key of the <tt>AbilityCategory</tt> to retrieve. * @return The requested <tt>AbilityCategory</tt> or <tt>null</tt> if the * category is not found in the current game mode. */ public static AbilityCategory getAbilityCategory(final String aKey) { return SettingsHandler.getGame().getAbilityCategory(aKey); } /** * Extracts the choiceless form of a name, for example, with all choices removed * * @param aName * * @return the name with sub-choices stripped from it */ public static String removeChoicesFromName(String aName) { final int anInt = aName.indexOf('('); return (anInt >= 0) ? aName.substring(0, anInt).trim() : aName; } /** * Takes a string of the form "foo (bar, baz)", populates the array with ["bar", "baz"] * and returns foo. All strings returned by this function have had leading.trailing * whitespace removed. * * @param name The full name with stuff in parenthesis * @param specifics a list which will contain the specifics after the operation has * completed * * @return the name with sub-choices stripped from it */ public static String getUndecoratedName( final String name, final Collection<String> specifics) { final String altName = removeChoicesFromName(name); specifics.clear(); final int start = name.indexOf('(') + 1; final int end = name.lastIndexOf(')'); if (start >= 0 && end > start) { // we want what is inside the outermost parenthesis. final String subName = name.substring(start, end); specifics.addAll(CoreUtility.split(subName, ',')); } return altName; } /** * Retrieve a list of all abilities in all categories associated * with a given key. e.g. Fighter feats are included when feats * are requested. * @param catKey The key of the category to be retrieved * @param pc The character to query * @return List of matching abilities. */ public static List<Ability> getAggregateAbilitiesListForKey(String catKey, PlayerCharacter pc) { Collection<AbilityCategory> cats = SettingsHandler.getGame().getAllAbilityCatsForKey(catKey); List<Ability> abilityList = new ArrayList<Ability>(); for (AbilityCategory abilityCategory : cats) { abilityList.addAll(pc.getAggregateAbilityList( abilityCategory)); } return abilityList; } /** * Clone anAbility, apply choices and add it to the addList, provided the * Ability allows it (if not isMultiples check if it's already there before * adding it). * * @param anAbility * @param choices * @param addList * @return the Ability added, or null if Ability was not added to the list. */ public static Ability addAbilityToListwithChoices( final Ability anAbility, final List<String> choices, final List<Ability> addList) { Ability abil = getAbilityFromList(addList, anAbility); if (abil == null) { abil = anAbility.clone(); addList.add(abil); } if (choices != null) { addChoicesToAbility(abil, choices); } return abil; } }

The table below shows all metrics for AbilityUtilities.java.

MetricValueDescription
BLOCKS114.00Number of blocks
BLOCK_COMMENT47.00Number of block comment lines
COMMENTS491.00Comment lines
COMMENT_DENSITY 1.33Comment density
COMPARISONS84.00Number of comparison operators
CYCLOMATIC126.00Cyclomatic complexity
DECL_COMMENTS205.00Comments in declarations
DOC_COMMENT241.00Number of javadoc comment lines
ELOC368.00Effective lines of code
EXEC_COMMENTS24.00Comments in executable code
EXITS87.00Procedure exits
FUNCTIONS24.00Number of function declarations
HALSTEAD_DIFFICULTY88.29Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY108.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 1.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 1.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA0034 0.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 3.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 1.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 0.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 0.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 0.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 0.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 0.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 1.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 0.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 1.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 2.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 2.00JAVA0144 Line exceeds maximum M characters
JAVA01452743.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 0.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 0.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 0.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 0.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES1206.00Number of lines in the source file
LINE_COMMENT203.00Number of line comments
LOC589.00Lines of code
LOGICAL_LINES186.00Number of statements
LOOPS 2.00Number of loops
NEST_DEPTH 9.00Maximum nesting depth
OPERANDS1097.00Number of operands
OPERATORS2114.00Number of operators
PARAMS68.00Number of formal parameter declarations
PROGRAM_LENGTH3211.00Halstead program length
PROGRAM_VOCAB339.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS40.00Number of return points from functions
SIZE33163.00Size of the file in bytes
UNIQUE_OPERANDS292.00Number of unique operands
UNIQUE_OPERATORS47.00Number of unique operators
WHITESPACE126.00Number of whitespace lines