Package org.bson.types

Class ObjectId

java.lang.Object
org.bson.types.ObjectId
All Implemented Interfaces:
Serializable, Comparable<ObjectId>
@Deprecated(since="2022-10-31") public final class ObjectId extends Object implements Comparable<ObjectId>, Serializable
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.

A globally unique identifier for objects.

Consists of 12 bytes, divided as follows:

ObjectID layout
01234567891011
timerandom valueinc

Instances of this class are immutable.

See Also:

  • Constructor Details

    • ObjectId

      public ObjectId()
      Deprecated.
      Create a new object id.

    • ObjectId

      public ObjectId(Date date)
      Deprecated.
      Constructs a new instance using the given date.
      Parameters:
      date - the date

    • ObjectId

      public ObjectId(Date date, int counter)
      Deprecated.
      Constructs a new instances using the given date and counter.
      Parameters:
      date - the date
      counter - the counter
      Throws:
      IllegalArgumentException - if the high order byte of counter is not zero

    • ObjectId

      @Deprecated public ObjectId(Date date, int machineIdentifier, short processIdentifier, int counter)
      Deprecated.
      Use ObjectId(Date, int) instead
      Constructs a new instances using the given date, machine identifier, process identifier, and counter.
      Parameters:
      date - the date
      machineIdentifier - the machine identifier
      processIdentifier - the process identifier
      counter - the counter
      Throws:
      IllegalArgumentException - if the high order byte of machineIdentifier or counter is not zero

    • ObjectId

      @Deprecated public ObjectId(int timestamp, int machineIdentifier, short processIdentifier, int counter)
      Deprecated.
      Use ObjectId(int, int) instead
      Creates an ObjectId using the given time, machine identifier, process identifier, and counter.
      Parameters:
      timestamp - the time in seconds
      machineIdentifier - the machine identifier
      processIdentifier - the process identifier
      counter - the counter
      Throws:
      IllegalArgumentException - if the high order byte of machineIdentifier or counter is not zero

    • ObjectId

      public ObjectId(int timestamp, int counter)
      Deprecated.
      Creates an ObjectId using the given time, machine identifier, process identifier, and counter.
      Parameters:
      timestamp - the time in seconds
      counter - the counter
      Throws:
      IllegalArgumentException - if the high order byte of counter is not zero

    • ObjectId

      public ObjectId(String hexString)
      Deprecated.
      Constructs a new instance from a 24-byte hexadecimal string representation.
      Parameters:
      hexString - the string to convert
      Throws:
      IllegalArgumentException - if the string is not a valid hex string representation of an ObjectId

    • ObjectId

      public ObjectId(byte[] bytes)
      Deprecated.
      Constructs a new instance from the given byte array
      Parameters:
      bytes - the byte array
      Throws:
      IllegalArgumentException - if array is null or not of length 12

    • ObjectId

      public ObjectId(ByteBuffer buffer)
      Deprecated.
      Constructs a new instance from the given ByteBuffer
      Parameters:
      buffer - the ByteBuffer
      Throws:
      IllegalArgumentException - if the buffer is null or does not have at least 12 bytes remaining
      Since:
      3.4

  • Method Details

    • get

      public static ObjectId get()
      Deprecated.
      Gets a new object id.
      Returns:
      the new id

    • isValid

      public static boolean isValid(String hexString)
      Deprecated.
      Checks if a string could be an ObjectId.
      Parameters:
      hexString - a potential ObjectId as a String.
      Returns:
      whether the string could be an object id
      Throws:
      IllegalArgumentException - if hexString is null

    • toByteArray

      public byte[] toByteArray()
      Deprecated.
      Convert to a byte array. Note that the numbers are stored in big-endian order.
      Returns:
      the byte array

    • putToByteBuffer

      public void putToByteBuffer(ByteBuffer buffer)
      Deprecated.
      Convert to bytes and put those bytes to the provided ByteBuffer. Note that the numbers are stored in big-endian order.
      Parameters:
      buffer - the ByteBuffer
      Throws:
      IllegalArgumentException - if the buffer is null or does not have at least 12 bytes remaining
      Since:
      3.4

    • getTimestamp

      public int getTimestamp()
      Deprecated.
      Gets the timestamp (number of seconds since the Unix epoch).
      Returns:
      the timestamp

    • getDate

      public Date getDate()
      Deprecated.
      Gets the timestamp as a Date instance.
      Returns:
      the Date

    • toHexString

      public String toHexString()
      Deprecated.
      Converts this instance into a 24-byte hexadecimal string representation.
      Returns:
      a string representation of the ObjectId in hexadecimal format

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(ObjectId other)
      Deprecated.
      Specified by:
      compareTo in interface Comparable<ObjectId>

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • createFromLegacyFormat

      @Deprecated public static ObjectId createFromLegacyFormat(int time, int machine, int inc)
      Deprecated.
      Use ObjectId(int, int) instead

      Creates an ObjectId using time, machine and inc values. The Java driver used to create all ObjectIds this way, but it does not match the ObjectId specification, which requires four values, not three. This major release of the Java driver conforms to the specification, but still supports clients that are relying on the behavior of the previous major release by providing this explicit factory method that takes three parameters instead of four.

      Ordinary users of the driver will not need this method. It's only for those that have written there own BSON decoders.

      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:
      a new ObjectId created from the given values
      Since:
      2.12.0

    • getCurrentCounter

      @Deprecated public static int getCurrentCounter()
      Deprecated.
      Gets the current value of the auto-incrementing counter.
      Returns:
      the current counter value.

    • getGeneratedMachineIdentifier

      @Deprecated public static int getGeneratedMachineIdentifier()
      Deprecated.
      Gets the generated machine identifier.
      Returns:
      an int representing the machine identifier

    • getGeneratedProcessIdentifier

      @Deprecated public static int getGeneratedProcessIdentifier()
      Deprecated.
      Gets the generated process identifier.
      Returns:
      the process id

    • getMachineIdentifier

      @Deprecated public int getMachineIdentifier()
      Deprecated.
      Gets the machine identifier.
      Returns:
      the machine identifier

    • getProcessIdentifier

      @Deprecated public short getProcessIdentifier()
      Deprecated.
      Gets the process identifier.
      Returns:
      the process identifier

    • getCounter

      @Deprecated public int getCounter()
      Deprecated.
      Gets the counter.
      Returns:
      the counter

    • getTimeSecond

      @Deprecated public int getTimeSecond()
      Deprecated.
      Use #getTimestamp instead
      Gets the time of this ID, in seconds.
      Returns:
      the time component of this ID in seconds

    • getTime

      @Deprecated public long getTime()
      Deprecated.
      Use #getDate instead
      Gets the time of this instance, in milliseconds.
      Returns:
      the time component of this ID in milliseconds

    • toStringMongod

      @Deprecated public String toStringMongod()
      Deprecated.
      use toHexString()
      Returns:
      a string representation of the ObjectId in hexadecimal format
      See Also: