com.allanbank.mongodb.bson.element

Class StringElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.StringElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable

public class StringElement
extends AbstractElement

A wrapper for a BSON string.

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

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

ELEMENT_TYPE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitString(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.
ElementType	getType() Returns the type for the BSON type.
String	getValue() Returns the BSON string value.
int	hashCode() Computes a reasonable hash code.
StringElement	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 string.

Constructor Detail

StringElement

public StringElement(String name,
             String value)

Constructs a new StringElement.

Parameters:

name - The name for the BSON string.

value - The BSON string value.

Throws:

IllegalArgumentException - If the name or value is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitString(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)

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValue

public String getValue()

Returns the BSON string value.

Returns:

The BSON string value.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

withName

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

Parameters:

name - The new name for the element.

Returns:

The created element.