|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.ascape.util.PropertyAccessor org.ascape.util.sweep.SweepDimension
public class SweepDimension
A class faciliating iteration across a paramater dimension. This class has the neat feature that it will set the object to the next value itself on a call to next.
Nested Class Summary | |
---|---|
class |
SweepDimension.TypedDoubleSweepDimension
|
class |
SweepDimension.TypedFloatSweepDimension
|
class |
SweepDimension.TypedIntegerSweepDimension
|
class |
SweepDimension.TypedLongSweepDimension
|
Field Summary |
---|
Fields inherited from class org.ascape.util.PropertyAccessor |
---|
descriptor, object, propertyClass |
Constructor Summary | |
---|---|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
double start,
double end,
double increment)
Constructs a dimension composed of the object and an double accessor (property) for that object, providing start, final , and increment values. |
|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
float start,
float end,
float increment)
Constructs a dimension composed of the object and an float accessor (property) for that object, providing start, final , and increment values. |
|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
int start,
int end)
Constructs a dimension composed of the object and an integer accessor (property) for that object, providing start, final , and increment values. |
|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
int start,
int end,
int increment)
Constructs a dimension composed of the object and an integer accessor (property) for that object, providing start, final , and increment values. |
|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
long start,
long end,
long increment)
Constructs a dimension composed of the object and an long accessor (property) for that object, providing start, final , and increment values. |
|
SweepDimension(java.lang.Object object,
java.lang.String accessorName,
java.lang.String start,
java.lang.String end,
java.lang.String increment)
Constructs a dimension composed of the object and an accessor (property) for that object, providing start, final , and increment values. |
Method Summary | |
---|---|
java.lang.String |
getIncrementAsText()
Returns the increment value as a text string. |
java.lang.String |
getMaxAsText()
Returns the maximum value as a text string. |
java.lang.String |
getMinAsText()
Returns the minimum value as a text string. |
boolean |
hasNext()
Returns true if the dimension hasn't yet reached its final (terminal) value. |
java.lang.Object |
next()
Iterates to the next dimension value, setting the property of the object with the new value. |
void |
reset()
Resets the dimension to its original value. |
void |
setIncrementAsText(java.lang.String string)
Sets the increment value as a text string. |
void |
setMaxAsText(java.lang.String string)
Sets the maximum value as a text string. |
void |
setMinAsText(java.lang.String string)
Sets the minimum value as a text string. |
Methods inherited from class org.ascape.util.PropertyAccessor |
---|
addSpacesToVariableName, capitalizeFirstCharacter, compareTo, determineReadWriteAccessors, getAsText, getAsText, getDescriptor, getLongName, getLongName, getName, getValue, getValue, isWriteable, isWriteable, paramName, paramValue, paramValueBoolean, paramValueInt, paramValueLong, removeUnderscores, setAsText, setAsText, setDescriptor, setValue, stringAsClass |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SweepDimension(java.lang.Object object, java.lang.String accessorName, java.lang.String start, java.lang.String end, java.lang.String increment)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (String)start
- the final (termination) value for the dimension (String)start
- the iteration amount for the dimension (String)public SweepDimension(java.lang.Object object, java.lang.String accessorName, int start, int end, int increment)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (int)start
- the final (termination) value for the dimension (int)start
- the iteration amount for the dimension (int)public SweepDimension(java.lang.Object object, java.lang.String accessorName, int start, int end)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (int)start
- the final (termination) value for the dimension (int)public SweepDimension(java.lang.Object object, java.lang.String accessorName, double start, double end, double increment)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (int)start
- the final (termination) value for the dimension (int)start
- the iteration amount for the dimension (int)public SweepDimension(java.lang.Object object, java.lang.String accessorName, float start, float end, float increment)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (int)start
- the final (termination) value for the dimension (int)start
- the iteration amount for the dimension (int)public SweepDimension(java.lang.Object object, java.lang.String accessorName, long start, long end, long increment)
object
- the object to have its state changed.accessorName
- the name of the accessor, following the standard Java propert pattern.start
- the start value for the dimension (int)start
- the final (termination) value for the dimension (int)start
- the iteration amount for the dimension (int)Method Detail |
---|
public java.lang.String getMinAsText()
public void setMinAsText(java.lang.String string)
public java.lang.String getMaxAsText()
public void setMaxAsText(java.lang.String string)
public java.lang.String getIncrementAsText()
public void setIncrementAsText(java.lang.String string)
public void reset()
reset
in interface Sweepable
public boolean hasNext()
hasNext
in interface Sweepable
public java.lang.Object next()
next
in interface Sweepable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |