Package com.mongodb

Class DBRef

java.lang.Object
com.mongodb.DBRef
All Implemented Interfaces:
Serializable

public class DBRef extends Object implements Serializable
A representation of a database reference.
See Also:
MongoDB documentation
Database References
  • Constructor Details

    • DBRef

      public DBRef(String collectionName, Object id)
      Construct an instance.
      Parameters:
      collectionName - the name of the collection where the document is stored
      id - the object id
    • DBRef

      public DBRef(@Nullable String databaseName, String collectionName, Object id)
      Construct an instance.
      Parameters:
      databaseName - the name of the database where the document is stored
      collectionName - the name of the collection where the document is stored
      id - the object id
      Since:
      3.3
  • Method Details

    • getId

      public Object getId()
      Gets the _id of the referenced document
      Returns:
      the _id of the referenced document
    • getCollectionName

      public String getCollectionName()
      Gets the name of the collection in which the referenced document is stored.
      Returns:
      the name of the collection in which the referenced is stored
    • getDatabaseName

      @Nullable public String getDatabaseName()
      Gets the name of the database in which the referenced document is stored. A null value implies that the referenced document is stored in the same database as the referring document.
      Returns:
      the possibly-null database name
      Since:
      3.3
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object