colony.common
Class Goal

java.lang.Object
  |
  +--colony.common.Goal

All Implemented Interfaces:

java.io.Serializable

public class Goal

extends Object

implements java.io.Serializable

Description of a map's goal to be used by droid software.

Goals contain the type of goal you must complete on a given map, an optional parameter which is usually a moniker, and a string description of the goal.

See Also:

Serialized Form

Specification Fields

• type: - byte // a general category of goals
• parameter: - Object // parameter to further define a goal
• description: - string // Human-readable text description of goal

Field Summary

static byte	COLLECT Goal of collecting as many objects as possible with the given moniker before the map's time limit runs out.
static byte	JOURNEY
static byte	STANDARD

Constructor Summary

Goal(byte type, Object parameter)
The constructor from parameters.

Method Summary

boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
String	getDescription()
Object	getParameter()
byte	getType()
static Goal	parse(String string) Creates a Goal from a String representation following the format in toString().
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode

Field Detail

COLLECT

public static final byte COLLECT

Goal of collecting as many objects as possible with the given moniker before the map's time limit runs out.

See Also:

Constant Field Values

JOURNEY

public static final byte JOURNEY

See Also:

Constant Field Values

STANDARD

public static final byte STANDARD

See Also:

Constant Field Values

Constructor Detail

Goal

public Goal(byte type,
            Object parameter)

The constructor from parameters.

Parameters:

type - type of goal, one of the byte constants listed above.

parameter - optional parameter, usually a moniker, associated with a goal type.

Method Detail

equals

public boolean equals(Object o)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Boolean.hashCode(), Hashtable

getDescription

public String getDescription()

Returns:

a String description of the goal.

getParameter

public Object getParameter()

Returns:

parameter

getType

public byte getType()

Returns:

type

parse

public static Goal parse(String string)

Creates a Goal from a String representation following the format in toString().

Returns:

a new Goal if the format is valid, null otherwise.

Requires:

string != null

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a String representation of this goal in the format type:parameter.