Package org.bson.types

Class Symbol

java.lang.Object

org.bson.types.Symbol

All Implemented Interfaces:

java.io.Serializable

public class Symbol
extends java.lang.Object
implements java.io.Serializable

Class to hold an instance of the BSON symbol type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Symbol(java.lang.String symbol) Construct a new instance with the given symbol.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Will compare equal to a String that is equal to the String that this holds
java.lang.String	getSymbol() Gets the symbol.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Symbol

public Symbol(java.lang.String symbol)

Construct a new instance with the given symbol.

Parameters:

symbol - the symbol

Method Detail

getSymbol

public java.lang.String getSymbol()

Gets the symbol.

Returns:

the symbol

equals

public boolean equals(java.lang.Object o)

Will compare equal to a String that is equal to the String that this holds

Overrides:

equals in class java.lang.Object

Parameters:

o - the Symbol to compare this to

Returns:

true if parameter o is the same as this Symbol

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object