com.neurosys.q.basic.domain

Class TokenStatus

java.lang.Object

com.neurosys.q.basic.domain.TokenStatus

All Implemented Interfaces:

Chainable<TokenStatus>, FlowStatus, Serializable, Comparable<TokenStatus>

@Embeddable
public class TokenStatus
extends Object
implements FlowStatus, Comparable<TokenStatus>, Chainable<TokenStatus>

A pure basic String based token status system. This allows new status to be defined and custom. the order is defined by ordinal().

For scalability space the ordinals for constants set by at least 10.

Also it is important to not the STATUS type in tokens is actually FlowStatus. This is just one possible implementation; however the API developer is not restricted to just using this.

Author:

Arjun Dhar

See Also:

TestConsumerTokenStatus, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenStatus()
TokenStatus(Consumer<TokenStatus> register)
TokenStatus(String name, int ordinal, Consumer<TokenStatus> register)
TokenStatus(String name, int ordinal, TokenStatus parent, Consumer<TokenStatus> register)

Method Summary

Modifier and Type	Method and Description
int	compareTo(TokenStatus o)
boolean	equals(Object obj)
String	getName()
Integer	getOrdinal()
TokenStatus	getParent()
int	hashCode()
String	name() The name of the state
int	ordinal() The order in which the Flow proceeds represented by an integer
void	setName(String name)
void	setOrdinal(Integer ordinal)
void	setParent(TokenStatus parent)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.domain.Chainable

chain

Constructor Detail

TokenStatus

public TokenStatus()

TokenStatus

public TokenStatus(Consumer<TokenStatus> register)

Parameters:

register - as Consumer that registers the constants

Can be null:

true

TokenStatus

public TokenStatus(String name,
                   int ordinal,
                   Consumer<TokenStatus> register)

Parameters:

name - as String

ordinal - as int (higher number means later in the flow)

register - as Consumer that registers the constants. (Nullable)

TokenStatus

public TokenStatus(String name,
                   int ordinal,
                   TokenStatus parent,
                   Consumer<TokenStatus> register)

Parameters:

name - as String

ordinal - as int (higher number means later in the flow)

parent - as TokenStatus as parent type

register - as Consumer that registers the constants. (Nullable)

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getOrdinal

public Integer getOrdinal()

Returns:

the ordinal

setOrdinal

public void setOrdinal(Integer ordinal)

Parameters:

ordinal - the ordinal to set

getParent

public TokenStatus getParent()

Returns:

the parent

Can be null:

true

setParent

public void setParent(TokenStatus parent)

Parameters:

parent - the parent to set

Can be null:

true

name

public String name()

Description copied from interface: FlowStatus

The name of the state

Specified by:

name in interface FlowStatus

ordinal

public int ordinal()

Description copied from interface: FlowStatus

The order in which the Flow proceeds represented by an integer

Specified by:

ordinal in interface FlowStatus

compareTo

public int compareTo(TokenStatus o)

Specified by:

compareTo in interface Comparable<TokenStatus>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object