com.allanbank.mongodb.bson.element

Class IntegerElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.IntegerElement

All Implemented Interfaces:

Element, ElementAssignable, NumericElement, Serializable

public class IntegerElement
extends AbstractElement
implements NumericElement

A wrapper for a BSON (signed 32-bit) integer.

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-2012, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static ElementType	TYPE The BSON type for a integer.

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

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
IntegerElement(String name, int value) Constructs a new IntegerElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitInteger(java.lang.String, int) method.
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.
double	getDoubleValue() Returns the value cast to a double.
int	getIntValue() Returns the value cast to an integer.
long	getLongValue() Returns the value cast to a long.
ElementType	getType() Returns the type for the BSON type.
int	getValue() Returns the BSON integer value.
int	hashCode() Computes a reasonable hash code.
IntegerElement	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, nullSafeEquals, queryPath, queryPath, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.allanbank.mongodb.bson.Element

find, find, findFirst, findFirst, getName, queryPath, queryPath

Methods inherited from interface com.allanbank.mongodb.bson.ElementAssignable

asElement

Field Detail

TYPE

public static final ElementType TYPE

The BSON type for a integer.

Constructor Detail

IntegerElement

public IntegerElement(String name,
              int value)

Constructs a new IntegerElement.

Parameters:

name - The name for the BSON integer.

value - The BSON integer value.

Throws:

IllegalArgumentException - If the name is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitInteger(java.lang.String, int) method.

Specified by:

accept in interface Element

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

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)

getDoubleValue

public double getDoubleValue()

Returns the value cast to a double.

Note: There may be a loss of precision using this method if the NumericElement is not a DoubleElement.

Overridden to return the integer value as a double.

Specified by:

getDoubleValue in interface NumericElement

Returns:

The numeric value as a double.

getIntValue

public int getIntValue()

Returns the value cast to an integer.

Note: There may be a loss of precision using this method if the NumericElement is not a IntegerElement.

Overridden to return the integer value.

Specified by:

getIntValue in interface NumericElement

Returns:

The numeric value as a double.

getLongValue

public long getLongValue()

Returns the value cast to a long.

Note: There may be a loss of precision using this method if the NumericElement is not a LongElement.

Overridden to return the integer value as a long.

Specified by:

getLongValue in interface NumericElement

Returns:

The numeric value as a double.

getType

public ElementType getType()

Returns the type for the BSON type.

Specified by:

getType in interface Element

Returns:

The type for the BSON type.

getValue

public int getValue()

Returns the BSON integer value.

Returns:

The BSON integer value.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

withName

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

Specified by:

withName in interface Element

Parameters:

name - The new name for the element.

Returns:

The created element.