com.allanbank.mongodb.bson.element

Class SymbolElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.SymbolElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable

public class SymbolElement
extends AbstractElement

A wrapper for a BSON symbol.

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

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

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
SymbolElement(String name, String symbol) Constructs a new SymbolElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitSymbol(java.lang.String, java.lang.String) 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.
String	getSymbol() Returns the BSON symbol value.
ElementType	getType() Returns the type for the BSON type.
int	hashCode() Computes a reasonable hash code.
SymbolElement	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

Field Detail

TYPE

public static final ElementType TYPE

The BSON type for a symbol.

Constructor Detail

SymbolElement

public SymbolElement(String name,
             String symbol)

Constructs a new SymbolElement.

Parameters:

name - The name for the BSON string.

symbol - The BSON symbol value.

Throws:

IllegalArgumentException - If the name or symbol is null.

Method Detail

accept

public void accept(Visitor visitor)

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

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)

getSymbol

public String getSymbol()

Returns the BSON symbol value.

Returns:

The BSON symbol value.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

withName

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

Parameters:

name - The new name for the element.

Returns:

The created element.