Package org.bson

Class BsonObjectId

java.lang.Object

org.bson.BsonValue

org.bson.BsonObjectId

All Implemented Interfaces:

Comparable<BsonObjectId>

public class BsonObjectId
extends BsonValue
implements Comparable<BsonObjectId>

A representation of the BSON ObjectId type.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
BsonObjectId()	Construct a new instance with a new ObjectId.
BsonObjectId(ObjectId value)	Construct a new instance with the given ObjectId instance.

Method Summary

Modifier and Type	Method	Description
int	compareTo(BsonObjectId o)
boolean	equals(Object o)
BsonType	getBsonType()	Gets the BSON type of this value.
ObjectId	getValue()	Get the ObjectId value.
int	hashCode()
String	toString()

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

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

Constructor Details

BsonObjectId

public BsonObjectId()

Construct a new instance with a new ObjectId.

BsonObjectId

public BsonObjectId(ObjectId value)

Construct a new instance with the given ObjectId instance.

Parameters:

value - the ObjectId

Method Details

getValue

public ObjectId getValue()

Get the ObjectId value.

Returns:

the ObjectId value

getBsonType

public BsonType getBsonType()

Description copied from class: BsonValue

Gets the BSON type of this value.

Specified by:

getBsonType in class BsonValue

Returns:

the BSON type, which may not be null (but may be BSONType.NULL)

compareTo

public int compareTo(BsonObjectId o)

Specified by:

compareTo in interface Comparable<BsonObjectId>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object