util

Class Bounds

java.lang.Object

util.Bounds

All Implemented Interfaces:

Serializable

public class Bounds
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOWNWARD
static int	UPWARD

Constructor Summary

Constructors

Constructor and Description
Bounds() Creates new Bounds
Bounds(int low, int high, boolean shouldBounce, Class bbClass, String bbName, String bbType) Creates new Bounds.

Method Summary

Modifier and Type	Method and Description
boolean	getBounce() Getter for property bounce.
int	getDirection(int currentPoint) Return whether the point between the bounds should go upward or downward.
int	getTargetHighPoint() Getter for property targetHighPoint.
int	getTargetLowPoint() Getter for property targetLowPoint.
String	toString() Return the current instance as a string.
static String	trendToString(int trend) Return the current trend as a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UPWARD

public static final int UPWARD

See Also:

Constant Field Values

DOWNWARD

public static final int DOWNWARD

See Also:

Constant Field Values

Constructor Detail

Bounds

public Bounds()

Creates new Bounds

Bounds

public Bounds(int low,
              int high,
              boolean shouldBounce,
              Class bbClass,
              String bbName,
              String bbType)

Creates new Bounds. The blackboard is only used when bounce is set to true, so bb can be null if bounce is false.

Parameters:

low - The desired low bound.

high - The desired high bound.

shouldBounce - True if the point between the bounds should bounce between the low and high, false if the point between the bounds should stay within the low and high bounds without necessarily reaching either low or high points.

bbClass - The blackboard class to use if bounce is true, or null.

bbName - The blackboard name to use if bounce is true, or null.

bbType - The blackboard type to use if bounce is true, or null.

Method Detail

getDirection

public int getDirection(int currentPoint)

Return whether the point between the bounds should go upward or downward. If this instance is configured to bounce, then the trend upward will return UPWARD about 80% of the time, and DOWNWARD the remaining 20% of the time; the trend downward will return DOWNWARD about 80% of the time and UPWARD the remaining 20% of the time.

Parameters:

currentPoint - The current point between the low and high bounds.

Returns:

DOWNWARD if the trend shows the object should shrink, UPWARD if the trend shows the object should grow.

toString

public String toString()

Return the current instance as a string.

Overrides:

toString in class Object

trendToString

public static String trendToString(int trend)

Return the current trend as a string.

Returns:

"UPWARD", or "DOWNWARD"

getBounce

public boolean getBounce()

Getter for property bounce.

Returns:

Value of property bounce.

getTargetHighPoint

public int getTargetHighPoint()

Getter for property targetHighPoint.

Returns:

Value of property targetHighPoint.

getTargetLowPoint

public int getTargetLowPoint()

Getter for property targetLowPoint.

Returns:

Value of property targetLowPoint.