com.whitestein.lsps.engine

Class Identifier

java.lang.Object

com.whitestein.lsps.engine.Identifier

All Implemented Interfaces:

java.io.Serializable

public final class Identifier
extends java.lang.Object
implements java.io.Serializable

Serializable identifier of a model instance or a task. For a string representation see methods toString() and fromString(String).

Author:

rba

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static Identifier	fromString(java.lang.String identifier) Creates an identifier from its string representation.
long	getModelInstanceId() Returns the model instance id.
java.lang.Long	getTaskId() Returns the task id.
int	hashCode()
static Identifier	ofModelInstance(long modelInstanceId) Creates an identifier for the specified model instance id.
static Identifier	ofTask(long modelInstanceId, long taskId) Creates an identifier for the specified model instance task.
java.lang.String	toString() Returns a string representation of this identifier.

Methods inherited from class java.lang.Object

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

Method Detail

ofModelInstance

public static Identifier ofModelInstance(long modelInstanceId)

Creates an identifier for the specified model instance id.

Parameters:

modelInstanceId - the model instance id

Returns:

an identifier for the specified model instance id

ofTask

public static Identifier ofTask(long modelInstanceId,
                                long taskId)

Creates an identifier for the specified model instance task.

Parameters:

modelInstanceId - the model instance id

taskId - the task id

Returns:

an identifier for the specified model instance task

getModelInstanceId

public long getModelInstanceId()

Returns the model instance id.

Returns:

the model instance id

getTaskId

public java.lang.Long getTaskId()

Returns the task id. Can be null.

Returns:

the task id

toString

public java.lang.String toString()

Returns a string representation of this identifier. Method fromString(String) converts the string representation back to the identifier.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this identifier

fromString

public static Identifier fromString(java.lang.String identifier)

Creates an identifier from its string representation.

Parameters:

identifier - the identifier string representation

Returns:

an identifier from its string representation

Throws:

java.lang.IllegalArgumentException - if the specified string is not a valid identifier

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object