Object/Class

reactivemongo.bson

BSONObjectID

Related Docs: class BSONObjectID | package bson

Permalink

object BSONObjectID extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONObjectID
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(array: Array[Byte]): BSONObjectID

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def fromTime(timeMillis: Long, fillOnlyTimestamp: Boolean = true): BSONObjectID

    Permalink

    Generates a new BSON ObjectID from the given timestamp in milliseconds.

    Generates a new BSON ObjectID from the given timestamp in milliseconds.

    +------------------------+------------------------+------------------------+------------------------+ + timestamp (in seconds) + machine identifier + thread identifier + increment + + (4 bytes) + (3 bytes) + (2 bytes) + (3 bytes) + +------------------------+------------------------+------------------------+------------------------+

    The included timestamp is the number of seconds since epoch, so a BSONObjectID time part has only a precision up to the second. To get a reasonably unique ID, you _must_ set onlyTimestamp to false.

    Crafting a BSONObjectID from a timestamp with fillOnlyTimestamp set to true is helpful for range queries, eg if you want of find documents an _id field which timestamp part is greater than or lesser than the one of another id.

    If you do not intend to use the produced BSONObjectID for range queries, then you'd rather use the generate method instead.

    fillOnlyTimestamp

    if true, the returned BSONObjectID will only have the timestamp bytes set; the other will be set to zero.

  11. def generate(): BSONObjectID

    Permalink

    Generates a new BSON ObjectID.

    Generates a new BSON ObjectID.

    +------------------------+------------------------+------------------------+------------------------+ + timestamp (in seconds) + machine identifier + thread identifier + increment + + (4 bytes) + (3 bytes) + (2 bytes) + (3 bytes) + +------------------------+------------------------+------------------------+------------------------+

    The returned BSONObjectID contains a timestamp set to the current time (in seconds), with the machine identifier, thread identifier and increment properly set.

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def parse(id: String): Try[BSONObjectID]

    Permalink

    Tries to make a BSON ObjectId element from a hexadecimal String representation.

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def unapply(id: BSONObjectID): Option[Array[Byte]]

    Permalink
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def apply(id: String): BSONObjectID

    Permalink

    Constructs a BSON ObjectId element from a hexadecimal String representation.

    Constructs a BSON ObjectId element from a hexadecimal String representation. Throws an exception if the given argument is not a valid ObjectID.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) parse(str: String): Try[BSONObjectID] should be considered instead of this method

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped