org.jcoderz.commons.types.samples
Class SampleLong

java.lang.Object
  org.jcoderz.commons.types.samples.SampleLong

All Implemented Interfaces:

Serializable, Comparable, RestrictedLong, StrongType

public final class SampleLong
extends Object
implements Serializable, RestrictedLong, Comparable

Holds the SampleLong.

 long[1..10].
 

Instances of this class are immutable.

This class implements the Comparable interface based on the numeric order of its instances.

Author:

generated via stylesheet

See Also:

Serialized Form

Field Summary

static SampleLong	CONSTANT_VALUE Additional Constant defined in the XML document.
static long	MAX_VALUE The maximum value of a SampleLong (10).
static long	MIN_VALUE The minimum value of a SampleLong (1).
static String	TYPE_NAME SampleLong - the name of this type as string constant.

Method Summary

int	compareTo(Object o) Compares this SampleLong with an other.
boolean	equals(Object obj)
static SampleLong	fromLong(long id) Construct a SampleLong object from its long representation.
static SampleLong	fromLong(Long id) Construct a SampleLong object from its Long representation.
static SampleLong	fromString(String s) Construct a SampleLong object from its string representation.
int	hashCode()
static SampleLong	random() Generates a random SampleLong object.
long	toLong() Returns the long representation of this SampleLong object.
Long	toLongObject() Returns the Long representation of this SampleLong object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final String TYPE_NAME

SampleLong - the name of this type as string constant.

See Also:

Constant Field Values

MIN_VALUE

public static final long MIN_VALUE

The minimum value of a SampleLong (1).

See Also:

Constant Field Values

MAX_VALUE

public static final long MAX_VALUE

The maximum value of a SampleLong (10).

See Also:

Constant Field Values

CONSTANT_VALUE

public static final SampleLong CONSTANT_VALUE

Additional Constant defined in the XML document.

Method Detail

fromLong

public static SampleLong fromLong(long id)
                           throws ArgumentMalformedException

Construct a SampleLong object from its long representation.

Parameters:

id - the long representation of the SampleLong

Returns:

the SampleLong object represented by the given long

Throws:

ArgumentMalformedException - If the given long id violates the restriction of the type SampleLong.

ArgumentMinValueViolationException - If the value of the given long id is below MIN_VALUE.

ArgumentMaxValueViolationException - If the value of the given long id is above MAX_VALUE.

fromString

public static SampleLong fromString(String s)
                             throws ArgumentMalformedException

Construct a SampleLong object from its string representation.

Parameters:

s - the string representation of the SampleLong

Returns:

the SampleLong object represented by the given string

Throws:

ArgumentMalformedException - If the given string s violates the restriction of the type SampleLong.

ArgumentMinValueViolationException - If the value of the given long id is below MIN_VALUE.

ArgumentMaxValueViolationException - If the value of the given long id is above MAX_VALUE.

fromLong

public static SampleLong fromLong(Long id)
                           throws ArgumentMalformedException

Construct a SampleLong object from its Long representation.

Parameters:

id - the Long representation of the SampleLong

Returns:

the SampleLong object represented by the given Long

Throws:

ArgumentMalformedException - If the given Long id is null or violates the restriction of the type SampleLong.

ArgumentMinValueViolationException - If the value of the given long id is below MIN_VALUE.

ArgumentMaxValueViolationException - If the value of the given long id is above MAX_VALUE.

random

public static SampleLong random()

Generates a random SampleLong object.

Returns:

a random SampleLong object.

toLong

public long toLong()

Returns the long representation of this SampleLong object.

Specified by:

toLong in interface RestrictedLong

Returns:

the long representation of this SampleLong object.

toLongObject

public Long toLongObject()

Returns the Long representation of this SampleLong object.

Specified by:

toLongObject in interface RestrictedLong

Returns:

the Long representation of this SampleLong object.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Object o)

Compares this SampleLong with an other. The order is based on the numeric order of the of the compared instances.

Specified by:

compareTo in interface Comparable

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this Object.

See Also:

Long.compareTo(Object)