ObjectId (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- org.bson.types.ObjectId

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<ObjectId>
```
public final class ObjectId
extends java.lang.Object
implements java.lang.Comparable<ObjectId>, java.io.Serializable
```
A globally unique identifier for objects.

Consists of 12 bytes, divided as follows:

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

time machine pid inc

Instances of this class are immutable.

另请参阅:

序列化表格

MongoDB documentation

ObjectId

ObjectID layout
0	1	2	3	4	5	6	7	8	9	10	11
time	machine	pid	inc

构造器概要

构造器
构造器和说明
`ObjectId()` Create a new object id.
`ObjectId(byte[] bytes)` Constructs a new instance from the given byte array
`ObjectId(java.util.Date date)` Constructs a new instance using the given date.
`ObjectId(java.util.Date date, int counter)` Constructs a new instances using the given date and counter.
`ObjectId(java.util.Date date, int machineIdentifier, short processIdentifier, int counter)` Constructs a new instances using the given date, machine identifier, process identifier, and counter.
`ObjectId(int timestamp, int machineIdentifier, short processIdentifier, int counter)` Creates an ObjectId using the given time, machine identifier, process identifier, and counter.
`ObjectId(java.lang.String hexString)` Constructs a new instance from a 24-byte hexadecimal string representation.

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`int`	`compareTo(ObjectId other)`
`static ObjectId`	`createFromLegacyFormat(int time, int machine, int inc)` Creates an ObjectId using time, machine and inc values.
`boolean`	`equals(java.lang.Object o)`
`static ObjectId`	`get()` Gets a new object id.
`int`	`getCounter()` Gets the counter.
`static int`	`getCurrentCounter()` Gets the current value of the auto-incrementing counter.
`java.util.Date`	`getDate()` Gets the timestamp as a `Date` instance.
`static int`	`getGeneratedMachineIdentifier()` Gets the generated machine identifier.
`static int`	`getGeneratedProcessIdentifier()` Gets the generated process identifier.
`int`	`getMachineIdentifier()` Gets the machine identifier.
`short`	`getProcessIdentifier()` Gets the process identifier.
`long`	`getTime()` 已过时。 Use #getDate instead
`int`	`getTimeSecond()` 已过时。 Use #getTimestamp instead
`int`	`getTimestamp()` Gets the timestamp (number of seconds since the Unix epoch).
`int`	`hashCode()`
`static boolean`	`isValid(java.lang.String hexString)` Checks if a string could be an `ObjectId`.
`byte[]`	`toByteArray()` Convert to a byte array.
`java.lang.String`	`toHexString()` Converts this instance into a 24-byte hexadecimal string representation.
`java.lang.String`	`toString()`
`java.lang.String`	`toStringMongod()` 已过时。 use `toHexString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - ObjectId
```
public ObjectId()
```
    Create a new object id.
  - ObjectId
```
public ObjectId(java.util.Date date)
```
    Constructs a new instance using the given date.
    
    参数:
    
    date - the date
  - ObjectId
```
public ObjectId(java.util.Date date,
                int counter)
```
    Constructs a new instances using the given date and counter.
    
    参数:
    
    date - the date
    
    counter - the counter
    
    抛出:
    
    java.lang.IllegalArgumentException - if the high order byte of counter is not zero
  - ObjectId
```
public ObjectId(java.util.Date date,
                int machineIdentifier,
                short processIdentifier,
                int counter)
```
    Constructs a new instances using the given date, machine identifier, process identifier, and counter.
    
    参数:
    
    date - the date
    
    machineIdentifier - the machine identifier
    
    processIdentifier - the process identifier
    
    counter - the counter
    
    抛出:
    
    java.lang.IllegalArgumentException - if the high order byte of machineIdentifier or counter is not zero
  - ObjectId
```
public ObjectId(int timestamp,
                int machineIdentifier,
                short processIdentifier,
                int counter)
```
    Creates an ObjectId using the given time, machine identifier, process identifier, and counter.
    
    参数:
    
    timestamp - the time in seconds
    
    machineIdentifier - the machine identifier
    
    processIdentifier - the process identifier
    
    counter - the counter
    
    抛出:
    
    java.lang.IllegalArgumentException - if the high order byte of machineIdentifier or counter is not zero
  - ObjectId
```
public ObjectId(java.lang.String hexString)
```
    Constructs a new instance from a 24-byte hexadecimal string representation.
    
    参数:
    
    hexString - the string to convert
    
    抛出:
    
    java.lang.IllegalArgumentException - if the string is not a valid hex string representation of an ObjectId
  - ObjectId
```
public ObjectId(byte[] bytes)
```
    Constructs a new instance from the given byte array
    
    参数:
    
    bytes - the byte array
    
    抛出:
    
    java.lang.IllegalArgumentException - if array is null or not of length 12
- 方法详细资料
  - get
```
public static ObjectId get()
```
    Gets a new object id.
    
    返回:
    
    the new id
  - isValid
```
public static boolean isValid(java.lang.String hexString)
```
    Checks if a string could be an ObjectId.
    
    参数:
    
    hexString - a potential ObjectId as a String.
    
    返回:
    
    whether the string could be an object id
    
    抛出:
    
    java.lang.IllegalArgumentException - if hexString is null
  - getGeneratedMachineIdentifier
```
public static int getGeneratedMachineIdentifier()
```
    Gets the generated machine identifier.
    
    返回:
    
    an int representing the machine identifier
  - getGeneratedProcessIdentifier
```
public static int getGeneratedProcessIdentifier()
```
    Gets the generated process identifier.
    
    返回:
    
    the process id
  - getCurrentCounter
```
public static int getCurrentCounter()
```
    Gets the current value of the auto-incrementing counter.
    
    返回:
    
    the current counter value.
  - createFromLegacyFormat
```
public static ObjectId createFromLegacyFormat(int time,
                                              int machine,
                                              int inc)
```
    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.
    
    参数:
    
    time - time in seconds
    
    machine - machine ID
    
    inc - incremental value
    
    返回:
    
    a new ObjectId created from the given values
    
    从以下版本开始:
    
    2.12.0
  - toByteArray
```
public byte[] toByteArray()
```
    Convert to a byte array. Note that the numbers are stored in big-endian order.
    
    返回:
    
    the byte array
  - getTimestamp
```
public int getTimestamp()
```
    Gets the timestamp (number of seconds since the Unix epoch).
    
    返回:
    
    the timestamp
  - getMachineIdentifier
```
public int getMachineIdentifier()
```
    Gets the machine identifier.
    
    返回:
    
    the machine identifier
  - getProcessIdentifier
```
public short getProcessIdentifier()
```
    Gets the process identifier.
    
    返回:
    
    the process identifier
  - getCounter
```
public int getCounter()
```
    Gets the counter.
    
    返回:
    
    the counter
  - getDate
```
public java.util.Date getDate()
```
    Gets the timestamp as a Date instance.
    
    返回:
    
    the Date
  - toHexString
```
public java.lang.String toHexString()
```
    Converts this instance into a 24-byte hexadecimal string representation.
    
    返回:
    
    a string representation of the ObjectId in hexadecimal format
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - compareTo
```
public int compareTo(ObjectId other)
```
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<ObjectId>
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getTimeSecond
```
@Deprecated
public int getTimeSecond()
```
    已过时。 Use #getTimestamp instead
    
    Gets the time of this ID, in seconds.
    
    返回:
    
    the time component of this ID in seconds
  - getTime
```
@Deprecated
public long getTime()
```
    已过时。 Use #getDate instead
    
    Gets the time of this instance, in milliseconds.
    
    返回:
    
    the time component of this ID in milliseconds
  - toStringMongod
```
@Deprecated
public java.lang.String toStringMongod()
```
    已过时。 use toHexString()
    
    返回:
    
    a string representation of the ObjectId in hexadecimal format
    
    另请参阅:
    
    toHexString()

类 ObjectId

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ObjectId

ObjectId

ObjectId

ObjectId

ObjectId

ObjectId

ObjectId

方法详细资料

get

isValid

getGeneratedMachineIdentifier

getGeneratedProcessIdentifier

getCurrentCounter

createFromLegacyFormat

toByteArray

getTimestamp

getMachineIdentifier

getProcessIdentifier

getCounter

getDate

toHexString

equals

hashCode

compareTo

toString

getTimeSecond

getTime

toStringMongod