org.termweb.api

Class TermWebID

java.lang.Object

org.termweb.api.TermWebID

All Implemented Interfaces:

Serializable

public class TermWebID
extends Object
implements Serializable

Represents an ID for an object in TermWeb.

See Also:

Serialized Form

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static TermWebID	NEW ID value for new objects.

Constructor Summary

Constructors

Constructor and Description
TermWebID(int id) Creates a new TermWebID from the specified int value.
TermWebID(long id) Creates a new TermWebID from the specified long value.
TermWebID(Long id) Creates a new TermWebID from the specified Long value.
TermWebID(String id) Creates a new TermWebID from the specified string representation of a Long value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static TermWebID	fromLongStr(String longStr) Parses the specified string as a long value and returns a TermWebID based on the value.
Long	getLong() Returns the ID as a Long value.
String	getString() Returns the ID as a String with the value in base-32 representation, using characters 0-9 and a-v.
int	hashCode()
boolean	isNew() Checks if the ID is new, i.e.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEW

public static final TermWebID NEW

ID value for new objects.

Constructor Detail

TermWebID

public TermWebID(String id)

Creates a new TermWebID from the specified string representation of a Long value. The value should be encoded in base-32 using characters 0-9 and a-v. NoteConversion between oid and TermWebID should normally be done by IDConvert.get(String)

Parameters:

id - The id as a String.

TermWebID

public TermWebID(long id)

Creates a new TermWebID from the specified long value.

Parameters:

id - The ID as a long value.

TermWebID

public TermWebID(int id)

Creates a new TermWebID from the specified int value.

Parameters:

id - The ID as an int value.

TermWebID

public TermWebID(Long id)

Creates a new TermWebID from the specified Long value.

Parameters:

id - The ID as a Long value.

Method Detail

getString

public String getString()

Returns the ID as a String with the value in base-32 representation, using characters 0-9 and a-v.

Returns:

The ID as a String.

getLong

public Long getLong()

Returns the ID as a Long value.

Returns:

The ID as a Long.

toString

public String toString()

Overrides:

toString in class Object

isNew

public boolean isNew()

Checks if the ID is new, i.e. the corresponding object has not been saved.

Returns:

True if it is new.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromLongStr

public static TermWebID fromLongStr(String longStr)

Parses the specified string as a long value and returns a TermWebID based on the value.

Parameters:

longStr - The long value.

Returns:

A TermWebID from the specified value. If value is null or blank string, TermWebID.NEW is returned.