Menu
▾
▴
[pcgen-commit-svn] SF.net SVN: pcgen: [750] Trunk/pcgen/code/src/java/pcgen/core
|
From: <kar...@us...> - 2006-04-11 11:35:28
|
Revision: 750 Author: karianna Date: 2006-04-11 04:34:44 -0700 (Tue, 11 Apr 2006) ViewCVS: http://svn.sourceforge.net/pcgen/?rev=750&view=rev Log Message: ----------- Javadoc Modified Paths: -------------- Trunk/pcgen/code/src/java/pcgen/core/Equipment.java Trunk/pcgen/code/src/java/pcgen/core/utils/ListKey.java Trunk/pcgen/code/src/java/pcgen/gui/editor/LanguageBasePanel.java Trunk/pcgen/code/src/java/pcgen/persistence/lst/LevelLstToken.java Trunk/pcgen/code/src/java/plugin/doomsdaybook/util/List.java Trunk/pcgen/code/src/java/plugin/exporttokens/LanguagesToken.java Trunk/pcgen/code/src/java/plugin/exporttokens/LengthToken.java Trunk/pcgen/code/src/java/plugin/exporttokens/LevelToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/kit/LevelAbilityToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/kit/clazz/LevelToken.java Trunk/pcgen/code/src/java/plugin/lsttokens/kit/levelability/LevelAbilityToken.java Trunk/pcgen/code/src/test/pcgen/core/levelability/LevelAbilityClassSkillsTest.java Modified: Trunk/pcgen/code/src/java/pcgen/core/Equipment.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/Equipment.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/pcgen/core/Equipment.java 2006-04-11 11:34:44 UTC (rev 750) @@ -4666,10 +4666,7 @@ { return getExpandedWeaponProf(aPC).getName(); } - else - { - return profName; - } + return profName; } /** Modified: Trunk/pcgen/code/src/java/pcgen/core/utils/ListKey.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/core/utils/ListKey.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/pcgen/core/utils/ListKey.java 2006-04-11 11:34:44 UTC (rev 750) @@ -30,63 +30,110 @@ */ public final class ListKey { + /** AUTO_ARRAY - a ListKey */ public static final ListKey AUTO_ARRAY = new ListKey(); + /** AUTO_LANGUAGES - a ListKey */ public static final ListKey AUTO_LANGUAGES = new ListKey(); + /** CLASS_SKILLS - a ListKey */ public static final ListKey CLASS_SKILLS = new ListKey(); + /** CROSS_CLASS_SKILLS - a ListKey */ public static final ListKey CROSS_CLASS_SKILLS = new ListKey(); + /** DOMAIN - a ListKey */ public static final ListKey DOMAIN = new ListKey(); + /** FILE_BIO_SET - a ListKey */ public static final ListKey FILE_BIO_SET = new ListKey(); + /** FILE_CLASS - a ListKey */ public static final ListKey FILE_CLASS = new ListKey(); + /** FILE_CLASS_SKILL - a ListKey */ public static final ListKey FILE_CLASS_SKILL = new ListKey(); + /** FILE_CLASS_SPELL - a ListKey */ public static final ListKey FILE_CLASS_SPELL = new ListKey(); + /** FILE_COIN - a ListKey */ public static final ListKey FILE_COIN = new ListKey(); + /** FILE_COMPANION_MOD - a ListKey */ public static final ListKey FILE_COMPANION_MOD = new ListKey(); + /** FILE_COVER - a ListKey */ public static final ListKey FILE_COVER = new ListKey(); + /** FILE_DEITY - a ListKey */ public static final ListKey FILE_DEITY = new ListKey(); + /** FILE_DOMAIN - a ListKey */ public static final ListKey FILE_DOMAIN = new ListKey(); + /** FILE_EQUIP - a ListKey */ public static final ListKey FILE_EQUIP = new ListKey(); + /** FILE_EQUIP_MOD - a ListKey */ public static final ListKey FILE_EQUIP_MOD = new ListKey(); + /** FILE_ABILITY - a ListKey */ public static final ListKey FILE_ABILITY = new ListKey(); + /** FILE_FEAT - a ListKey */ public static final ListKey FILE_FEAT = new ListKey(); + /** FILE_KIT - a ListKey */ public static final ListKey FILE_KIT = new ListKey(); + /** FILE_LANGUAGE - a ListKey */ public static final ListKey FILE_LANGUAGE = new ListKey(); + /** FILE_LST_EXCLUDE - a ListKey */ public static final ListKey FILE_LST_EXCLUDE = new ListKey(); + /** FILE_PCC - a ListKey */ public static final ListKey FILE_PCC = new ListKey(); + /** FILE_RACE - a ListKey */ public static final ListKey FILE_RACE = new ListKey(); + /** FILE_REQ_SKILL - a ListKey */ public static final ListKey FILE_REQ_SKILL = new ListKey(); + /** FILE_SKILL - a ListKey */ public static final ListKey FILE_SKILL = new ListKey(); + /** FILE_SPELL - a ListKey */ public static final ListKey FILE_SPELL = new ListKey(); + /** FILE_TEMPLATE - a ListKey */ public static final ListKey FILE_TEMPLATE = new ListKey(); + /** FILE_WEAPON_PROF - a ListKey */ public static final ListKey FILE_WEAPON_PROF = new ListKey(); + /** GAME_MODE - a ListKey */ public static final ListKey GAME_MODE = new ListKey(); + /** KITS - a ListKey */ public static final ListKey KITS = new ListKey(); + /** LICENSE - a ListKey */ public static final ListKey LICENSE = new ListKey(); + /** LICENSE_FILE - a ListKey */ public static final ListKey LICENSE_FILE = new ListKey(); + /** LINE - a ListKey */ public static final ListKey LINE = new ListKey(); + /** NATURAL_WEAPONS - a ListKey */ public static final ListKey NATURAL_WEAPONS = new ListKey(); + /** PANTHEON - a ListKey */ public static final ListKey PANTHEON = new ListKey(); + /** RACE_PANTHEON - a ListKey */ public static final ListKey RACEPANTHEON = new ListKey(); + /** REMOVE_STRING_LIST - a ListKey */ public static final ListKey REMOVE_STRING_LIST = new ListKey(); + /** SAVE - a ListKey */ public static final ListKey SAVE = new ListKey(); + /** SECTION 15 - a ListKey */ public static final ListKey SECTION_15 = new ListKey(); + /** SELECTED_ARMOR_PROFS - a ListKey */ public static final ListKey SELECTED_ARMOR_PROF = new ListKey(); + /** SELECTED_SHIELD_PROFS - a ListKey */ public static final ListKey SELECTED_SHIELD_PROFS = new ListKey(); + /** SELECTED_WEAPON_PROF_BONUS - a ListKey */ public static final ListKey SELECTED_WEAPON_PROF_BONUS = new ListKey(); + /** SPECIAL_ABILITY - a ListKey */ public static final ListKey SPECIAL_ABILITY = new ListKey(); + /** TEMPLATES - a ListKey */ public static final ListKey TEMPLATES = new ListKey(); + /** TEMPLATES_ADDED - a ListKey */ public static final ListKey TEMPLATES_ADDED = new ListKey(); + /** TEMP_BONUS - a ListKey */ public static final ListKey TEMP_BONUS = new ListKey(); + /** TYPE - a ListKey */ public static final ListKey TYPE = new ListKey(); + /** UDAM - a ListKey */ public static final ListKey UDAM = new ListKey(); + /** UMULT - a ListKey */ public static final ListKey UMULT = new ListKey(); /** Key for a list of virtual feats (feats granted regardless of the prereqs) */ public static final ListKey VIRTUAL_FEATS = new ListKey(); /** Key for a list of weapon proficiencies */ public static final ListKey WEAPON_PROF = new ListKey(); - /** - * Private constructor to prevent instantiation of this class. - */ + /** Private constructor to prevent instantiation of this class */ private ListKey() { //Only allow instantation here } Modified: Trunk/pcgen/code/src/java/pcgen/gui/editor/LanguageBasePanel.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/gui/editor/LanguageBasePanel.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/pcgen/gui/editor/LanguageBasePanel.java 2006-04-11 11:34:44 UTC (rev 750) @@ -51,16 +51,30 @@ initComponentContents(); } + /** + * Set the list of available types + * @param aList + * @param sort + */ public void setTypesAvailableList(final List aList, final boolean sort) { pnlLanguageType.setAvailableList(aList, sort); } + /** + * Set the list of selected types + * @param aList + * @param sort + */ public void setTypesSelectedList(final List aList, final boolean sort) { pnlLanguageType.setSelectedList(aList, sort); } + /** + * Get the list of selected types + * @return the list of selected types + */ public Object[] getTypesSelectedList() { return pnlLanguageType.getSelectedList(); Modified: Trunk/pcgen/code/src/java/pcgen/persistence/lst/LevelLstToken.java =================================================================== --- Trunk/pcgen/code/src/java/pcgen/persistence/lst/LevelLstToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/pcgen/persistence/lst/LevelLstToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -33,8 +33,9 @@ * @author Devon Jones <sou...@ev...> */ public interface LevelLstToken extends LstToken { + /** - * @param penalty + * @param levelInfo * @param value * @return true if parse OK */ Modified: Trunk/pcgen/code/src/java/plugin/doomsdaybook/util/List.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/doomsdaybook/util/List.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/doomsdaybook/util/List.java 2006-04-11 11:34:44 UTC (rev 750) @@ -29,11 +29,24 @@ this(allVars, "", "", 1); } + /** + * Constructor + * @param allVars + * @param title + * @param id + */ public List(VariableHashMap allVars, String title, String id) { this(allVars, title, id, 1); } + /** + * Constructor + * @param allVars + * @param title + * @param id + * @param weight + */ public List(VariableHashMap allVars, String title, String id, int weight) { this.allVars = allVars; @@ -118,6 +131,10 @@ return retList; } + /** + * Set the id of the list + * @param id + */ public void setId(String id) { this.id = id; @@ -133,6 +150,10 @@ return retList; } + /** + * Get the range + * @return the range + */ public int getRange() { int rangeTop = 0; @@ -151,6 +172,10 @@ return rangeTop; } + /** + * Set the title of the list + * @param title + */ public void setTitle(String title) { this.title = title; @@ -161,6 +186,10 @@ return title; } + /** + * Set the weight + * @param weight + */ public void setWeight(int weight) { this.weight = weight; Modified: Trunk/pcgen/code/src/java/plugin/exporttokens/LanguagesToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/exporttokens/LanguagesToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/exporttokens/LanguagesToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -32,9 +32,12 @@ import java.util.SortedSet; import java.util.StringTokenizer; -//LANGUAGES.x +/** + * LANGUAGES.x Token + */ public class LanguagesToken extends Token { + /** Token Name */ public static final String TOKENNAME = "LANGUAGES"; /** @@ -88,6 +91,12 @@ return langBuf.toString(); } + /** + * Get the languages token + * @param pc + * @param languageIndex + * @return the languages token + */ public static String getLanguagesToken(PlayerCharacter pc, int languageIndex) { SortedSet languageSet = pc.getLanguagesList(); Modified: Trunk/pcgen/code/src/java/plugin/exporttokens/LengthToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/exporttokens/LengthToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/exporttokens/LengthToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -29,9 +29,12 @@ import pcgen.io.ExportHandler; import pcgen.io.exporttoken.Token; -//LENGTH.HAIR +/** + * LENGTH.HAIR Token + */ public class LengthToken extends Token { + /** Token name */ public static final String TOKENNAME = "LENGTH"; /** @@ -58,6 +61,11 @@ return retString; } + /** + * Get the hair length token + * @param pc + * @return the hair length token + */ public static String getHairToken(PlayerCharacter pc) { return pc.getHairStyle(); Modified: Trunk/pcgen/code/src/java/plugin/exporttokens/LevelToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/exporttokens/LevelToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/exporttokens/LevelToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -35,9 +35,12 @@ import java.util.Iterator; import java.util.StringTokenizer; -//LEVEL +/** + * LEVEL token + */ public class LevelToken extends Token { + /** Token name */ public static final String TOKENNAME = "LEVEL"; /** @@ -102,21 +105,45 @@ return retString; } + /** + * Get the level class name + * @param pc + * @param pcl + * @return the level class name + */ public static String getLevelClassName(PlayerCharacter pc, PCLevelInfo pcl) { return pcl.getClassKeyName(); } + /** + * Get the level class level + * @param pc + * @param pcl + * @return the level class level + */ public static String getLevelClassLevel(PlayerCharacter pc, PCLevelInfo pcl) { return Integer.toString(pcl.getLevel()); } + /** + * Get the list of feats for the level + * @param pc + * @param pcl + * @return the list of feats for the level + */ public static String getLevelFeatList(PlayerCharacter pc, PCLevelInfo pcl) { return ""; } + /** + * Get the HP for the level + * @param pc + * @param pcl + * @return the HP for the level + */ public static String getLevelHP(PlayerCharacter pc, PCLevelInfo pcl) { String classKeyName = pcl.getClassKeyName(); @@ -136,6 +163,11 @@ return ""; } + /** + * Get the skill points for the level + * @param pcl + * @return the skill points for the level + */ public static String getLevelSkillPoints(PCLevelInfo pcl) { return Integer.toString(pcl.getSkillPointsGained()); Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/kit/LevelAbilityToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/kit/LevelAbilityToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/kit/LevelAbilityToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -53,10 +53,8 @@ * @param value * the token string * @return true if parse OK - * @throws PersistenceLayerException */ public boolean parse(Kit aKit, String value) - throws PersistenceLayerException { try { Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/kit/clazz/LevelToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/kit/clazz/LevelToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/kit/clazz/LevelToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -28,6 +28,9 @@ import pcgen.core.kit.KitClass; import pcgen.persistence.lst.KitClassLstToken; +/** + * LevelToken (a component of Kits) + */ public class LevelToken implements KitClassLstToken { public boolean parse(KitClass kitClass, String value) Modified: Trunk/pcgen/code/src/java/plugin/lsttokens/kit/levelability/LevelAbilityToken.java =================================================================== --- Trunk/pcgen/code/src/java/plugin/lsttokens/kit/levelability/LevelAbilityToken.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/java/plugin/lsttokens/kit/levelability/LevelAbilityToken.java 2006-04-11 11:34:44 UTC (rev 750) @@ -29,6 +29,9 @@ import pcgen.persistence.lst.KitLevelAbilityLstToken; import pcgen.util.Logging; +/** + * Level Ability token (a component of Kits) + */ public class LevelAbilityToken implements KitLevelAbilityLstToken { /** Modified: Trunk/pcgen/code/src/test/pcgen/core/levelability/LevelAbilityClassSkillsTest.java =================================================================== --- Trunk/pcgen/code/src/test/pcgen/core/levelability/LevelAbilityClassSkillsTest.java 2006-04-11 02:17:04 UTC (rev 749) +++ Trunk/pcgen/code/src/test/pcgen/core/levelability/LevelAbilityClassSkillsTest.java 2006-04-11 11:34:44 UTC (rev 750) @@ -39,12 +39,16 @@ import pcgen.util.chooser.ChooserFactory; import pcgen.util.chooser.ChooserInterface; +/** + * Tests for Level Ability Class Skills + */ public class LevelAbilityClassSkillsTest extends AbstractCharacterTestCase { PCClass pcClass; Race emptyRace = new Race(); boolean firstTime = true; - /* + + /* * @see TestCase#setUp() */ protected void setUp() throws Exception { @@ -74,7 +78,7 @@ super.tearDown(); } - /* + /** * Test method for 'pcgen.core.levelability.LevelAbilityClassSkills.getChoicesList(String, PlayerCharacter)' */ public void testGetChoicesList1() { @@ -108,7 +112,7 @@ } } - /* + /** * Test method for 'pcgen.core.levelability.LevelAbilityClassSkills.getChoicesList(String, PlayerCharacter)' */ public void testGetChoicesList2() { @@ -146,7 +150,8 @@ Logging.debugPrint("Ignoring Headless excpetion."); } } - /* + + /** * Test method for 'pcgen.core.levelability.LevelAbilityClassSkills.getChoicesList(String, PlayerCharacter)' */ public void testGetChoicesList3() { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
