ObjectId (hbatis 1.0.0 API)

java.lang.Object
- plus.ibatis.hbatis.keygen.ObjectId

所有已实现的接口:: Serializable, Comparable<ObjectId>

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

另请参阅:: 序列化表格

构造器概要

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

ObjectId

ObjectId

方法详细资料

get

isValid

toByteArray

putToByteBuffer

getTimestamp

getDate

toHexString

equals

hashCode

compareTo

toString

createFromLegacyFormat

getCurrentCounter

getGeneratedMachineIdentifier

getGeneratedProcessIdentifier

getMachineIdentifier

getProcessIdentifier

getCounter

getTimeSecond

getTime

toStringMongod