org.dizitart.no2

Class NitriteId

java.lang.Object

org.dizitart.no2.NitriteId

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NitriteId>

public final class NitriteId
extends java.lang.Object
implements java.lang.Comparable<NitriteId>, java.io.Serializable

An unique identifier across the Nitrite database. Each document in a nitrite collection is associated with a NitriteId.

During insertion if an unique object is supplied in the '_id' field of the document, then the value of the '_id' field will be used to create a new NitriteId. If that is not supplied, then nitrite will auto generate one and supply it in the '_id' field of the document.

Since:

1.0

See Also:

PersistentCollection.getById(NitriteId), Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(NitriteId other)
static NitriteId	createId(java.lang.Long value) Creates a NitriteId from a long value.
boolean	equals(java.lang.Object o)
java.lang.Long	getIdValue() Gets the underlying id object.
int	hashCode()
static NitriteId	newId() Gets a new auto-generated NitriteId.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newId

public static NitriteId newId()

Gets a new auto-generated NitriteId.

Returns:

a new auto-generated NitriteId.

createId

public static NitriteId createId(java.lang.Long value)

Creates a NitriteId from a long value.

Parameters:

value - the value

Returns:

the NitriteId

compareTo

public int compareTo(NitriteId other)

Specified by:

compareTo in interface java.lang.Comparable<NitriteId>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIdValue

public java.lang.Long getIdValue()

Gets the underlying id object.

Returns:

the underlying id object.

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