Menu
▾
▴
[pcgen-commit-svn] SF.net SVN: pcgen:[9372] Trunk/pcgen/code/src/java/pcgen/cdom/choiceset
|
From: <th...@us...> - 2009-02-13 23:07:30
|
Revision: 9372
http://pcgen.svn.sourceforge.net/pcgen/?rev=9372&view=rev
Author: thpr
Date: 2009-02-13 23:07:26 +0000 (Fri, 13 Feb 2009)
Log Message:
-----------
more doc updates
Modified Paths:
--------------
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityFromClassChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityRefChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ChoiceSetUtilities.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ClassReferenceChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/CompoundOrChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ModifyChoiceDecorator.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/QualifiedDecorator.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ReferenceChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SimpleChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellCasterChoiceSet.java
Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellReferenceChoiceSet.java
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityFromClassChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityFromClassChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityFromClassChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -31,30 +31,58 @@
import pcgen.core.PlayerCharacter;
import pcgen.core.pclevelinfo.PCLevelInfo;
+/**
+ * An AbilityFromClassChoiceSet is a PrimitiveChoiceSet that draws Abilities
+ * from a specific PCClass. These Ability objects are previously selected
+ * Ability objects; thus AbilityFromClassChoiceSet is intended to be used during
+ * object removal from a PlayerCharacter, not object addition.
+ *
+ * In particular, AbilityFromClassChoiceSet is designed to handle
+ * REMOVE:FEAT|Class.???
+ */
public class AbilityFromClassChoiceSet implements
PrimitiveChoiceSet<AbilitySelection>
{
+ /**
+ * The underlying class from which this AbilityFromClassChoiceSet can draw
+ * Abilities
+ */
private final CDOMSingleRef<PCClass> cl;
+ /**
+ * Constructs a new AbilityFromClassChoiceSet which refers to the PCClass
+ * provided in the given CDOMSingleRef.
+ *
+ * @param pcc
+ * A reference to the PCClass this AbilityFromClassChoiceSet can
+ * draw Abilities from
+ */
public AbilityFromClassChoiceSet(CDOMSingleRef<PCClass> pcc)
{
cl = pcc;
}
+ /**
+ * Returns a representation of this AbilityFromClassChoiceSet, suitable for
+ * storing in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this AbilityFromClassChoiceSet, suitable for
+ * storing in an LST file.
+ */
public String getLSTformat(boolean useAny)
{
return "CLASS." + cl.getLSTformat();
}
/**
- * Returns true if this AbilityFromClassReference is equal to the given
- * Object. Equality is defined as being another AbilityFromClassReference
- * object with equal Class represented by the reference, an equal staring
- * CDOMGroupRef and an equal pattern. This may or may not be a deep .equals,
- * depending on the behavior of the underlying CDOMGroupRef. You should
- * check the documentation for the .equals(Object) method of that class to
- * establish the actual behavior of this method.
+ * Returns true if this AbilityFromClassChoiceSet is equal to the given
+ * Object. Equality is defined as being another AbilityFromClassChoiceSet
+ * object with equal Class represented by the reference provided during
+ * construction of the AbilityFromClassChoiceSets
*
* @see java.lang.Object#equals(java.lang.Object)
*/
@@ -71,7 +99,7 @@
/**
* Returns the consistent-with-equals hashCode for this
- * AbilityFromClassReference
+ * AbilityFromClassChoiceSet
*
* @see java.lang.Object#hashCode()
*/
@@ -81,11 +109,32 @@
return cl.hashCode();
}
+ /**
+ * Returns the Class contained within this AbilityFromClassChoiceSet
+ *
+ * @return the Class contained within this AbilityFromClassChoiceSet
+ */
public Class<? super AbilitySelection> getChoiceClass()
{
return AbilitySelection.class;
}
+ /**
+ * Returns a Set containing the Objects which this AbilityFromClassChoiceSet
+ * contains.
+ *
+ * This method is value-semantic, meaning that ownership of the Set returned
+ * by this method will be transferred to the calling object. Modification of
+ * the returned Set will not modify the AbilityFromClassChoiceSet, and
+ * modifying the AbilityFromClassChoiceSet after the Set is returned will
+ * not modify the Set.
+ *
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * AbilityFromClassChoiceSet should be returned.
+ * @return A Set containing the Objects which this AbilityFromClassChoiceSet
+ * contains.
+ */
public Set<AbilitySelection> getSet(PlayerCharacter pc)
{
PCClass aClass = cl.resolvesTo().getActiveEquivalent(pc);
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityRefChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityRefChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/AbilityRefChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -49,9 +49,6 @@
* The contents of a AbilityRefChoiceSet is defined at construction of the
* AbilityRefChoiceSet. The contents of a AbilityRefChoiceSet is fixed, and will
* not vary by the PlayerCharacter used to resolve the AbilityRefChoiceSet.
- *
- * @param <T>
- * The class of object this AbilityRefChoiceSet contains.
*/
public class AbilityRefChoiceSet implements
PrimitiveChoiceSet<AbilitySelection>
@@ -86,12 +83,23 @@
* references are kept to the AbilityRef objects contained within the given
* Collection.
*
+ * @param cat
+ * The Ability Category of Ability objects that this
+ * AbilityRefChoiceSet refers to.
+ * @param n
+ * The Ability Nature of the Ability objects as they should be
+ * applied to a PlayerCharacter
+ * @param allowDupe
+ * True if this AbilityRefChoiceSet should allow duplicates in
+ * the returned Set of AbilitySelection objects; false otherwise
+ * @param dupCount
+ * Sets the limit of duplicate objects (or stacking limit) to
+ * identify how many times an Ability may be available to a
+ * PlayerCharacter using an AbilityRefChoiceSet. Ignored if
+ * allowDupe is false.
* @param col
* A Collection of CDOMReferences which define the Set of objects
* contained within the AbilityRefChoiceSet
- * @param dupChoices
- * @param allowDupes
- * @param nature
* @throws IllegalArgumentException
* if the given Collection is null or empty.
*/
@@ -126,6 +134,12 @@
/**
* Returns a representation of this AbilityRefChoiceSet, suitable for
* storing in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this AbilityRefChoiceSet, suitable for
+ * storing in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -165,8 +179,11 @@
* Ownership of the Set returned by this method will be transferred to the
* calling object. Modification of the returned Set should not result in
* modifying the AbilityRefChoiceSet, and modifying the AbilityRefChoiceSet
- * after the Set is returned should not modify the Set.
+ * after the Set is returned should not modify the Set.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * AbilityRefChoiceSet should be returned.
* @return A Set containing the Objects which this AbilityRefChoiceSet
* contains.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ChoiceSetUtilities.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ChoiceSetUtilities.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ChoiceSetUtilities.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -107,15 +107,19 @@
* Ownership of the Collection provided to this method is not transferred
* and this constructor will not modify the given Collection.
*
- * @param strings
+ * @param c
* An Collection of PrimitiveChoiceSet objects
* @param separator
* The separating string
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
* @return A 'separator' separated String containing the LST format of the
* given Collection of PrimitiveChoiceSet objects
*/
- public static <T extends PrimitiveChoiceSet<?>> String joinLstFormat(
- Collection<T> c, String separator, boolean useAny)
+ public static String joinLstFormat(
+ Collection<? extends PrimitiveChoiceSet<?>> c, String separator,
+ boolean useAny)
{
if (c == null)
{
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ClassReferenceChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ClassReferenceChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ClassReferenceChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -45,9 +45,6 @@
* Note: This is a transition class for a feature to be removed after 5.16 is
* released. It is used only in the special case of a FAVOREDCLASS:CHOOSE in a
* Race LST file.
- *
- * @param <T>
- * The class of object this ReferenceChoiceSet contains.
*/
public class ClassReferenceChoiceSet implements PrimitiveChoiceSet<PCClass>
{
@@ -98,6 +95,12 @@
/**
* Returns a representation of this ClassReferenceChoiceSet, suitable for
* storing in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this ClassReferenceChoiceSet, suitable for
+ * storing in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -140,6 +143,9 @@
* returned set will result in modification of the PCClass objects contained
* within this ClassReferenceChoiceSet.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * ClassReferenceChoiceSet should be returned.
* @return A Set containing the Objects which this ClassReferenceChoiceSet
* contains.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/CompoundOrChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/CompoundOrChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/CompoundOrChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -69,13 +69,13 @@
* @throws IllegalArgumentException
* if the given Collection is null or empty.
*/
- public CompoundOrChoiceSet(Collection<PrimitiveChoiceSet<T>> coll)
+ public CompoundOrChoiceSet(Collection<PrimitiveChoiceSet<T>> col)
{
- if (coll == null)
+ if (col == null)
{
throw new IllegalArgumentException();
}
- set.addAll(coll);
+ set.addAll(col);
}
/**
@@ -90,6 +90,9 @@
* will result in modification of the PCClass objects contained within this
* ClassReferenceChoiceSet.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * CompoundOrChoiceSet should be returned.
* @return A Set containing the Objects which this CompoundOrChoiceSet
* contains.
*/
@@ -110,6 +113,8 @@
* @param useAny
* use "ANY" for the global "ALL" reference when creating the LST
* format
+ * @return A representation of this CompoundOrChoiceSet, suitable for
+ * storing in an LST file.
*/
public String getLSTformat(boolean useAny)
{
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ModifyChoiceDecorator.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ModifyChoiceDecorator.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ModifyChoiceDecorator.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -71,6 +71,8 @@
* @param useAny
* use "ANY" for the global "ALL" reference when creating the LST
* format
+ * @return A representation of this ModifyChoiceDecorator, suitable for
+ * storing in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -88,6 +90,9 @@
* ModifyChoiceDecorator (and vice versa since the ModifyChoiceDecorator is
* near immutable)
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * ModifyChoiceDecorator should be returned.
* @return A Set containing the Objects which this ModifyChoiceDecorator
* contains and which are also possessed by the PlayerCharacter.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/QualifiedDecorator.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/QualifiedDecorator.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/QualifiedDecorator.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -83,6 +83,8 @@
* @param useAny
* use "ANY" for the global "ALL" reference when creating the LST
* format
+ * @return A representation of this QualifiedDecorator, suitable for storing
+ * in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -102,6 +104,9 @@
* the objects contained within the returned Set will modify the objects
* within this QualifiedDecorator.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * QualifiedDecorator should be returned.
* @return A Set containing the Objects which this QualifiedDecorator
* contains.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ReferenceChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ReferenceChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/ReferenceChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -93,6 +93,12 @@
/**
* Returns a representation of this ReferenceChoiceSet, suitable for storing
* in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this ReferenceChoiceSet, suitable for storing
+ * in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -134,6 +140,9 @@
* result in modification of the object contained in this
* ReferenceChoiceSet.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * ReferenceChoiceSet should be returned.
* @return A Set containing the Objects which this ReferenceChoiceSet
* contains.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SimpleChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SimpleChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SimpleChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -42,7 +42,8 @@
* @param <T>
* The class of object this SimpleChoiceSet contains.
*/
-public class SimpleChoiceSet<T extends Comparable<T>> implements PrimitiveChoiceSet<T>
+public class SimpleChoiceSet<T extends Comparable<T>> implements
+ PrimitiveChoiceSet<T>
{
/**
@@ -85,6 +86,12 @@
/**
* Returns a representation of this SimpleChoiceSet, suitable for storing in
* an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this SimpleChoiceSet, suitable for storing in
+ * an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -115,6 +122,9 @@
* the objects contained in the Set will result in modification of the
* objects within this SimpleChoiceSet.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * SimpleChoiceSet should be returned.
* @return A Set containing the Objects which this SimpleChoiceSet contains.
*/
public Set<T> getSet(PlayerCharacter pc)
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellCasterChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellCasterChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellCasterChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -44,9 +44,6 @@
* SpellCasterChoiceSet. The contents of a SpellCasterChoiceSet is fixed, and
* will not vary by the PlayerCharacter used to resolve the
* SpellCasterChoiceSet.
- *
- * @param <T>
- * The class of object this ReferenceChoiceSet contains.
*/
public class SpellCasterChoiceSet extends ChoiceSet<PCClass> implements
PrimitiveChoiceSet<PCClass>
@@ -124,14 +121,19 @@
* SpellCasterChoiceSet, and the SpellCasterChoiceSet will not modify the
* given List.
*
- * @param spelltypes
* @param allRef
- *
+ * The "ALL" Reference for PCClass objects
+ * @param spelltype
+ * A List of spell types that this SpellCasterChoiceSet will
+ * allow to be used to select a PCClass
* @param col
* A Collection of CDOMReferences which define the Set of objects
- * contained within the SpellCasterChoiceSet
- * @throws IllegalArgumentException
- * if the given Collection is null or empty.
+ * contained within the SpellCasterChoiceSet which were
+ * referenced by group (e.g. TYPE=)
+ * @param prim
+ * A Collection of CDOMReferences which define the Set of
+ * primitive objects contained within the SpellCasterChoiceSet
+ * which were referenced by key
*/
public SpellCasterChoiceSet(CDOMGroupRef<PCClass> allRef,
List<String> spelltype, PrimitiveChoiceSet<PCClass> col,
@@ -147,6 +149,9 @@
/**
* Returns a representation of this SpellCasterChoiceSet, suitable for
* storing in an LST file.
+ *
+ * @return A representation of this SpellCasterChoiceSet, suitable for
+ * storing in an LST file.
*/
@Override
public String getLSTformat()
@@ -157,17 +162,23 @@
/**
* Returns a representation of this SpellCasterChoiceSet, suitable for
* storing in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this SpellCasterChoiceSet, suitable for
+ * storing in an LST file.
*/
- public String getLSTformat(boolean b)
+ public String getLSTformat(boolean useAny)
{
List<String> list = new ArrayList<String>();
if (primitives != null)
{
- list.add(primitives.getLSTformat(b));
+ list.add(primitives.getLSTformat(useAny));
}
if (pcset != null)
{
- list.add(pcset.getLSTformat(b));
+ list.add(pcset.getLSTformat(useAny));
}
if (!spelltypes.isEmpty())
{
@@ -208,6 +219,9 @@
* returned set will result in modification of the PCClass objects contained
* within this SpellCasterChoiceSet.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * SpellCasterChoiceSet should be returned.
* @return A Set containing the Objects which this SpellCasterChoiceSet
* contains.
*/
Modified: Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellReferenceChoiceSet.java
===================================================================
--- Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellReferenceChoiceSet.java 2009-02-13 22:51:08 UTC (rev 9371)
+++ Trunk/pcgen/code/src/java/pcgen/cdom/choiceset/SpellReferenceChoiceSet.java 2009-02-13 23:07:26 UTC (rev 9372)
@@ -98,6 +98,12 @@
/**
* Returns a representation of this SpellReferenceChoiceSet, suitable for
* storing in an LST file.
+ *
+ * @param useAny
+ * use "ANY" for the global "ALL" reference when creating the LST
+ * format
+ * @return A representation of this SpellReferenceChoiceSet, suitable for
+ * storing in an LST file.
*/
public String getLSTformat(boolean useAny)
{
@@ -162,6 +168,9 @@
* SpellReferenceChoiceSet, and modifying the SpellReferenceChoiceSet after
* the Set is returned should not modify the Set.
*
+ * @param pc
+ * The PlayerCharacter for which the choices in this
+ * SpellReferenceChoiceSet should be returned.
* @return A Set containing the CDOMListObjects which this
* SpellReferenceChoiceSet contains.
*/
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|