as.leap.las.sdk

Class ObjectId

java.lang.Object

as.leap.las.sdk.ObjectId

All Implemented Interfaces:

Serializable, Comparable<ObjectId>

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectId() Create a new object id.
ObjectId(byte[] b) Constructs an ObjectId given its 12-byte binary representation.
ObjectId(Date time)
ObjectId(Date time, int inc)
ObjectId(Date time, int machine, int inc)
ObjectId(int time, int machine, int inc) Deprecated. ObjectId's constructed this way do not conform to the ObjectId specification. createFromLegacyFormat(int, int, int) instead.
ObjectId(String s) Creates a new instance from a string.
ObjectId(String s, boolean babble) Deprecated. 'babble' format is deprecated. Please use ObjectId(String) instead.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ObjectId id)
static ObjectId	createFromLegacyFormat(int time, int machine, int inc) Creates an ObjectId using time, machine and inc values.
boolean	equals(Object o)
static ObjectId	get() Gets a new object id.
static int	getCurrentCounter()
static int	getCurrentInc()
Date	getDate() Gets the timestamp as a Date instance.
static int	getGenMachineId()
int	getTimestamp() Gets the timestamp (number of seconds since the Unix epoch).
int	hashCode()
static boolean	isValid(String s) Checks if a string could be an ObjectId.
static ObjectId	massageToObjectId(Object o) Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.
byte[]	toByteArray()
String	toHexString() Converts this instance into a 24-byte hexadecimal string representation.
String	toString()
String	toStringMongod() Deprecated. Please use toHexString() instead.
static void	validate(String msg, String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectId

public ObjectId(Date time)

ObjectId

public ObjectId(Date time,
                int inc)

ObjectId

public ObjectId(Date time,
                int machine,
                int inc)

ObjectId

public ObjectId(String s)

Creates a new instance from a string.

Parameters:

s - the string to convert

Throws:

IllegalArgumentException - if the string is not a valid id

ObjectId

@Deprecated
public ObjectId(String s,
                            boolean babble)

Deprecated. 'babble' format is deprecated. Please use ObjectId(String) instead.

Constructs a new instance of ObjectId from a string.

Parameters:

s - the string representation of ObjectId. Can contains only [0-9]|[a-f]|[A-F] characters.

babble - if true - convert to 'babble' objectId format

ObjectId

public ObjectId(byte[] b)

Constructs an ObjectId given its 12-byte binary representation.

Parameters:

b - a byte array of length 12

ObjectId

@Deprecated
public ObjectId(int time,
                            int machine,
                            int inc)

Deprecated. ObjectId's constructed this way do not conform to the ObjectId specification. createFromLegacyFormat(int, int, int) instead.

Constructs an ObjectId using time, machine and inc values. The Java driver has done it this way for a long time, but it does not match the ObjectId specification, which requires four values, not three. The next major release of the Java driver will conform to this specification, but we will still need to support clients that are relying on the current behavior. To that end, this constructor is now deprecated in favor of the more explicit factory method ObjectId#createFromLegacyFormat(int, int, int)}, and in the next major release this constructor will be removed.

Parameters:

time - time in seconds

machine - machine ID

inc - incremental value

See Also:

createFromLegacyFormat(int, int, int)

ObjectId

public ObjectId()

Create a new object id.

Method Detail

get

public static ObjectId get()

Gets a new object id.

Returns:

the new id

createFromLegacyFormat

public static ObjectId createFromLegacyFormat(int time,
                                              int machine,
                                              int inc)

Creates an ObjectId using time, machine and inc values. The Java driver has done it this way for a long time, but it does not match the ObjectId specification, which requires four values, not three. The next major release of the Java driver will conform to this specification, but will still need to support clients that are relying on the current behavior. To that end, the constructors that takes these three arguments are now deprecated in favor of this more explicit factory method, and in the next major release those constructors will be removed.

NOTE: This will not break any application that use ObjectIds. The 12-byte representation will be round-trippable from old to new driver releases.

Parameters:

time - time in seconds

machine - machine ID

inc - incremental value

Returns:

The ObjectId

Since:

2.12.0

isValid

public static boolean isValid(String s)

Checks if a string could be an ObjectId.

Parameters:

s - The object string

Returns:

whether the string could be an object id

massageToObjectId

@Deprecated
public static ObjectId massageToObjectId(Object o)

Deprecated. This method is NOT a part of public API and will be dropped in 3.x versions.

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toHexString

public String toHexString()

Converts this instance into a 24-byte hexadecimal string representation.

Returns:

a string representation of the ObjectId in hexadecimal format

toStringMongod

@Deprecated
public String toStringMongod()

Deprecated. Please use toHexString() instead.

Returns:

a string representation of the ObjectId in hexadecimal format

toByteArray

public byte[] toByteArray()

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ObjectId id)

Specified by:

compareTo in interface Comparable<ObjectId>

getTimestamp

public int getTimestamp()

Gets the timestamp (number of seconds since the Unix epoch).

Returns:

the timestamp

getDate

public Date getDate()

Gets the timestamp as a Date instance.

Returns:

the Date

getGenMachineId

public static int getGenMachineId()

getCurrentCounter

public static int getCurrentCounter()

getCurrentInc

public static int getCurrentInc()

validate

public static void validate(String msg,
                            String s)