Package org.bson

Class BsonSymbol

java.lang.Object

org.bson.BsonValue

org.bson.BsonSymbol

public class BsonSymbol
extends BsonValue

Class to hold a BSON symbol object, which is an interned string in Ruby

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
BsonSymbol(java.lang.String value) Creates a new instance.

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
BsonType	getBsonType() Gets the BSON type of this value.
java.lang.String	getSymbol() Gets the symbol value
int	hashCode()
java.lang.String	toString()

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

BsonSymbol

public BsonSymbol(java.lang.String value)

Creates a new instance.

Parameters:

value - the symbol value

Method Detail

getBsonType

public BsonType getBsonType()

Description copied from class: BsonValue

Gets the BSON type of this value.

Specified by:

getBsonType in class BsonValue

Returns:

the BSON type, which may not be null (but may be BSONType.NULL)

getSymbol

public java.lang.String getSymbol()

Gets the symbol value

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