com.allanbank.mongodb.bson.element

Class TimestampElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.TimestampElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

public class TimestampElement
extends AbstractElement

A wrapper for a BSON timestamp as the milliseconds since the epoch.

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 ElementType	TYPE The BSON type for a long.

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

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
TimestampElement(String name, long value) Constructs a new TimestampElement.
TimestampElement(String name, long value, long size) Constructs a new TimestampElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitTimestamp(java.lang.String, long) 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.
long	getTime() Returns the BSON timestamp value as the milliseconds since the epoch.
ElementType	getType() Returns the type for the BSON type.
Date	getValueAsObject() Returns the value for BSON element as a Java Object type.
int	hashCode() Computes a reasonable hash code.
TimestampElement	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

TYPE

public static final ElementType TYPE

The BSON type for a long.

Constructor Detail

TimestampElement

public TimestampElement(String name,
                long value)

Constructs a new TimestampElement.

Parameters:

name - The name for the BSON long.

value - The BSON timestamp value as the milliseconds since the epoch.

Throws:

IllegalArgumentException - If the name is null.

TimestampElement

public TimestampElement(String name,
                long value,
                long size)

Constructs a new TimestampElement.

Parameters:

name - The name for the BSON long.

value - The BSON timestamp value as the milliseconds since the epoch.

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

Throws:

IllegalArgumentException - If the name is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitTimestamp(java.lang.String, long) 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 times if the base class comparison is equals.

Note that for MongoDB MongoTimestampElement and TimestampElement will return equal based on the type. Care is taken here to make sure that the values return the same value regardless of comparison order.

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)

getTime

public long getTime()

Returns the BSON timestamp value as the milliseconds since the epoch.

Returns:

The BSON timestamp value as the milliseconds since the epoch.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

public Date 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 Date.

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 TimestampElement 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 TimestampElement.

Parameters:

name - The new name for the element.

Returns:

The created element.