com.allanbank.mongodb.bson.element

Class ObjectId

java.lang.Object

com.allanbank.mongodb.bson.element.ObjectId

All Implemented Interfaces:

Serializable, Comparable<ObjectId>

public class ObjectId
extends Object
implements Serializable, Comparable<ObjectId>

An Object Id.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static long	MACHINE_ID The current process's machine id.

Constructor Summary

Constructors

Constructor and Description
ObjectId() Constructs a new ObjectId.
ObjectId(int timestamp, long machineId) Constructs a new ObjectId.
ObjectId(String hexBytes) Constructs a new ObjectId.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ObjectId other)
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
int	getCounterField() The low 3 byte value of the machine id.
long	getMachineId() The lower 8 bytes of the object id.
int	getMachineIdentifier() The upper 3 bytes in the machine id.
int	getPidField() Middle 2 byte process id field from the machine id.
int	getTimestamp() The upper 4 bytes of the object id.
int	hashCode() Computes a reasonable hash code.
String	toHexString() Returns the HEX string form of the ObjectId.
String	toString() String form of the object.

Methods inherited from class java.lang.Object

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

Field Detail

MACHINE_ID

public static final long MACHINE_ID

The current process's machine id.

Constructor Detail

ObjectId

public ObjectId()

Constructs a new ObjectId.

ObjectId

public ObjectId(int timestamp,
        long machineId)

Constructs a new ObjectId.

Parameters:

timestamp - The BSON Object Id timestamp.

machineId - The BSON Object Id machine id.

ObjectId

public ObjectId(String hexBytes)
         throws IllegalArgumentException

Constructs a new ObjectId.

Parameters:

hexBytes - The hex encoded byte value.

Throws:

IllegalArgumentException - If the hex encoded string is not 24 characters.

Method Detail

compareTo

public int compareTo(ObjectId other)

Overridden to compare the object ids based on the tuple (timestamp, machineId).

Specified by:

compareTo in interface Comparable<ObjectId>

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getCounterField

public int getCounterField()

The low 3 byte value of the machine id.

Returns:

The low 3 byte value of the machine id.

getMachineId

public long getMachineId()

The lower 8 bytes of the object id. This is the machine identifier field and counter.

Returns:

The lower 8 bytes of the object id.

getMachineIdentifier

public int getMachineIdentifier()

The upper 3 bytes in the machine id.

Returns:

The upper 3 bytes of the machine id.

getPidField

public int getPidField()

Middle 2 byte process id field from the machine id.

Returns:

The middle 2 byte process id field from the machine id.

getTimestamp

public int getTimestamp()

The upper 4 bytes of the object id. This is the seconds since the UNIX Epoch.

Returns:

The upper 4 bytes of the object id.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.

toHexString

public String toHexString()

Returns the HEX string form of the ObjectId.

Returns:

The HEX string form of the ObjectId.

toString

public String toString()

String form of the object.

Overrides:

toString in class Object

Returns:

A human readable form of the object.

See Also:

Object.toString()