com.allanbank.mongodb.bson.element

Class MaxKeyElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.MaxKeyElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

public class MaxKeyElement
extends AbstractElement

A wrapper for a BSON maximum key element.

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

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

ELEMENT_TYPE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitMaxKey(java.lang.String) method.
ElementType	getType() Returns the type for the BSON type.
Double	getValueAsObject() Returns the value for BSON element as a Java Object type.
MaxKeyElement	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, compareTo, equals, find, find, findFirst, findFirst, getName, getValueAsString, hashCode, 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 binary.

Constructor Detail

MaxKeyElement

public MaxKeyElement(String name)

Constructs a new MaxKeyElement.

Parameters:

name - The name for the BSON maximum key.

Throws:

IllegalArgumentException - If the name is null.

MaxKeyElement

public MaxKeyElement(String name,
             long size)

Constructs a new MaxKeyElement.

Parameters:

name - The name for the BSON maximum key.

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

Throws:

IllegalArgumentException - If the name is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitMaxKey(java.lang.String) method.

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

public Double 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 a Double with the value Double.POSITIVE_INFINITY.

Note: This value will not be recreated is a Object-->Element conversion. Double with the Double.POSITIVE_INFINITY value is created instead.

Returns:

The value for BSON element as a Java Object type.

withName

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

Parameters:

name - The new name for the element.

Returns:

The created element.