org.bson.types.ObjectId Class Reference

Inheritance diagram for org.bson.types.ObjectId:

Public Member Functions
	ObjectId (Date time)
	ObjectId (Date time, int inc)
	ObjectId (Date time, int machine, int inc)
	ObjectId (String s)
	ObjectId (String s, boolean babble)
	ObjectId (byte[] b)
	ObjectId (int time, int machine, int inc)
	ObjectId ()
int	hashCode ()
boolean	equals (Object o)
String	toStringBabble ()
String	toStringMongod ()
byte[]	toByteArray ()
String	toString ()
int	compareTo (ObjectId id)
int	getMachine ()
long	getTime ()
int	getTimeSecond ()
int	getInc ()
int	_time ()
int	_machine ()
int	_inc ()
boolean	isNew ()
void	notNew ()

Static Public Member Functions
static ObjectId	get ()
static boolean	isValid (String s)
static ObjectId	massageToObjectId (Object o)
static String	babbleToMongod (String b)
static int	getGenMachineId ()
static int	getCurrentInc ()
static int	_flip (int x)

Detailed Description

A globally unique identifier for objects.

Consists of 12 bytes, divided as follows:

0
1
2
3
4
5
6
    
7
8
9
10
11


time
machine
    
pid
inc

objectids

Constructor & Destructor Documentation

org.bson.types.ObjectId.ObjectId ( String  s )

inline

Creates a new instance from a string.

Parameters

s	the string to convert

Exceptions

IllegalArgumentException

if the string is not a valid id

org.bson.types.ObjectId.ObjectId ( int  time, int  machine, int  inc  )

inline

Creates an ObjectId

Parameters

time	time in seconds
machine	machine ID
inc	incremental value

org.bson.types.ObjectId.ObjectId ( )

inline

Create a new object id.

Member Function Documentation

static ObjectId org.bson.types.ObjectId.get ( )

inlinestatic

Gets a new object id.

Returns

the new id

static int org.bson.types.ObjectId.getCurrentInc ( )

inlinestatic

Gets the current value of the auto increment

static int org.bson.types.ObjectId.getGenMachineId ( )

inlinestatic

Gets the generated machine ID, identifying the machine / process / class loader

long org.bson.types.ObjectId.getTime ( )

inline

Gets the time of this ID, in milliseconds

int org.bson.types.ObjectId.getTimeSecond ( )

inline

Gets the time of this ID, in seconds

static boolean org.bson.types.ObjectId.isValid ( String  s )

inlinestatic

Checks if a string could be an ObjectId.

Returns

whether the string could be an object id

static ObjectId org.bson.types.ObjectId.massageToObjectId ( Object  o )

inlinestatic

Turn an object into an ObjectId, if possible. Strings will be converted into ObjectIds, if possible, and ObjectIds will be cast and returned. Passing in null returns null.

Parameters

o	the object to convert

Returns

an ObjectId if it can be massaged, null otherwise

---

The documentation for this class was generated from the following file:

• /var/lib/jenkins/workspace/compile_db_x86_branch_2.6/sequoiadb/driver/java/src/main/java/org/bson/types/ObjectId.java