com.allanbank.mongodb.bson.element

Class ObjectIdElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.ObjectIdElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

public class ObjectIdElement
extends AbstractElement

A wrapper for a BSON Object Id.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The BSON type for a Object Id.
static ElementType	TYPE The BSON type for a Object Id.

Fields inherited from class com.allanbank.mongodb.bson.element.AbstractElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
ObjectIdElement(String name, ObjectId id) Constructs a new ObjectIdElement.
ObjectIdElement(String name, ObjectId id, long size) Constructs a new ObjectIdElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitObjectId(java.lang.String, com.allanbank.mongodb.bson.element.ObjectId) method.
int	compareTo(Element otherElement)
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
ObjectId	getId() Returns the id value.
ElementType	getType() Returns the type for the BSON type.
ObjectId	getValueAsObject() Returns the value for BSON element as a Java Object type.
int	hashCode() Computes a reasonable hash code.
ObjectIdElement	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from class com.allanbank.mongodb.bson.element.AbstractElement

asElement, find, find, findFirst, findFirst, getName, getValueAsString, nullSafeEquals, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

The BSON type for a Object Id.

See Also:

Constant Field Values

TYPE

public static final ElementType TYPE

The BSON type for a Object Id.

Constructor Detail

ObjectIdElement

public ObjectIdElement(String name,
               ObjectId id)

Constructs a new ObjectIdElement.

Parameters:

name - The name for the BSON Object Id.

id - The object id.

Throws:

IllegalArgumentException - If the name or id is null.

ObjectIdElement

public ObjectIdElement(String name,
               ObjectId id,
               long size)

Constructs a new ObjectIdElement.

Parameters:

name - The name for the BSON Object Id.

id - The object id.

size - The size of the element when encoded in bytes. If not known then use the ObjectIdElement(String, ObjectId) constructor instead.

Throws:

IllegalArgumentException - If the name or id is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitObjectId(java.lang.String, com.allanbank.mongodb.bson.element.ObjectId) method.

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

compareTo

public int compareTo(Element otherElement)

Overridden to compare the elements based on the tuple (name, type, value).

Overridden to compare the elements based on the tuple (name, type). Derived classes are responsible for the value portion of the full comparison.

Overridden to compare the values if the base class comparison is equals.

Specified by:

compareTo in interface Element

Specified by:

compareTo in interface Comparable<Element>

Overrides:

compareTo in class AbstractElement

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class AbstractElement

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getId

public ObjectId getId()

Returns the id value.

Returns:

The id value.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

public ObjectId getValueAsObject()

Returns the value for BSON element as a Java Object type.

Automatic conversion from the Object-ified value to an element is provided via the DocumentBuilder.add(String, Object) method. Not all element types will be successfully converted to the same element duing a Element-->Object value-->Element conversion. This cases are noted in the appropriate sub-type's JavaDoc.

Sub-types will also overload this method with the appropriate type returned. e.g., The StringElement.getValueAsObject() method signature returns a String.

Returns the ObjectId.

Returns:

The value for BSON element as a Java Object type.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

withName

public ObjectIdElement withName(String name)

Creates a new element with the same type and value as this element but with the specified name. This is useful when creating a query across a set of collections where the filed name changes in the collections but the values must be identical.

Returns a new ObjectIdElement.

Parameters:

name - The new name for the element.

Returns:

The created element.