com.partnersoft.data

Class Progress

java.lang.Object

com.partnersoft.data.Progress

All Implemented Interfaces:

Coggable, Immutable

public class Progress
extends java.lang.Object
implements Coggable, Immutable

Constructor Summary

Constructors

Constructor and Description
Progress(Cog state)
Progress(java.lang.String name, java.lang.String units, int value, int minimumValue, int maximumValue)
Progress(java.lang.String name, java.lang.String units, MathValueInInterval value)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object notherObject)
int	getMaximumValue()
int	getMinimumValue()
java.lang.String	getName()
java.lang.String	getUnits()
MathValueInInterval	getValue()
int	hashCode()
Progress	incrementedBy(int amount)
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.
java.lang.String	toString()
Progress	withName(java.lang.String newName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Progress

public Progress(java.lang.String name,
        java.lang.String units,
        MathValueInInterval value)

Progress

public Progress(java.lang.String name,
        java.lang.String units,
        int value,
        int minimumValue,
        int maximumValue)

Progress

public Progress(Cog state)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object notherObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getName

public java.lang.String getName()

getUnits

public java.lang.String getUnits()

getValue

public MathValueInInterval getValue()

getMinimumValue

public int getMinimumValue()

getMaximumValue

public int getMaximumValue()

incrementedBy

public Progress incrementedBy(int amount)

withName

public Progress withName(java.lang.String newName)