NitriteId (Nitrite 4.2.0 API)

java.lang.Object
- org.dizitart.no2.collection.NitriteId

All Implemented Interfaces:

Serializable, Comparable<NitriteId>
```
public final class NitriteId
extends Object
implements Comparable<NitriteId>, Serializable
```
A unique identifier across the Nitrite database. Each document in a nitrite collection is associated with a NitriteId.
During insertion if a 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 the '_id' field is not supplied, then nitrite will generate a new [NitriteId] and will add it to the document.

Since:

1.0

Author:

Anindya Chatterjee

See Also:

NitriteCollection.getById(NitriteId), Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(NitriteId other)`
`static NitriteId`	`createId(String value)`	Creates a `NitriteId` from a value.
`boolean`	`equals(Object o)`
`String`	`getIdValue()`	Gets the underlying value of the NitriteId.
`int`	`hashCode()`
`static NitriteId`	`newId()`	Creates a new auto-generated `NitriteId`.
`String`	`toString()`
`static boolean`	`validId(Object value)`	Validates a value to be used as `NitriteId`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newId
```
public static NitriteId newId()
```
    Creates a new auto-generated NitriteId.
    
    Returns:
    
    a new auto-generated NitriteId.
  - createId
```
public static NitriteId createId(String value)
```
    Creates a NitriteId from a value.
    The value must be a string representation of a 64bit integer number.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the NitriteId
  - validId
```
public static boolean validId(Object value)
```
    Validates a value to be used as NitriteId.
    The value must be a string representation of a 64bit integer number.
    
    Parameters:
    
    value - the value
    
    Returns:
    
    `true` if the value is valid; otherwise `false`.
  - compareTo
```
public int compareTo(NitriteId other)
```
    Specified by:
    
    compareTo in interface Comparable<NitriteId>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getIdValue
```
public String getIdValue()
```
    Gets the underlying value of the NitriteId.
    The value is a string representation of a 64bit integer number.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object