Package org.bson

Class BsonTimestamp

java.lang.Object

org.bson.BsonValue

org.bson.BsonTimestamp

All Implemented Interfaces:

java.lang.Comparable<BsonTimestamp>

public final class BsonTimestamp
extends BsonValue
implements java.lang.Comparable<BsonTimestamp>

A value representing the BSON timestamp type.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
BsonTimestamp() Construct a new instance with a null time and a 0 increment.
BsonTimestamp(int seconds, int increment) Construct a new instance for the given time and increment.
BsonTimestamp(long value) Construct a new instance for the given value, which combines the time in seconds and the increment as a single long value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(BsonTimestamp ts)
boolean	equals(java.lang.Object o)
BsonType	getBsonType() Gets the BSON type of this value.
int	getInc() Gets the increment value.
int	getTime() Gets the time in seconds since epoch.
long	getValue() Gets the value of the timestamp.
int	hashCode()
java.lang.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 Detail

BsonTimestamp

public BsonTimestamp()

Construct a new instance with a null time and a 0 increment.

BsonTimestamp

public BsonTimestamp(long value)

Construct a new instance for the given value, which combines the time in seconds and the increment as a single long value.

Parameters:

value - the timetamp as a single long value

Since:

3.5

BsonTimestamp

public BsonTimestamp(int seconds,
                     int increment)

Construct a new instance for the given time and increment.

Parameters:

seconds - the number of seconds since the epoch

increment - the increment.

Method Detail

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)

getValue

public long getValue()

Gets the value of the timestamp.

Returns:

the timestamp value

Since:

3.5

getTime

public int getTime()

Gets the time in seconds since epoch.

Returns:

an int representing time in seconds since epoch

getInc

public int getInc()

Gets the increment value.

Returns:

an incrementing ordinal for operations within a given second

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(BsonTimestamp ts)

Specified by:

compareTo in interface java.lang.Comparable<BsonTimestamp>

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