BsonSymbol (mongo-java-driver 3.12.10 API)

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 Description

BsonSymbol(String value)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(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.
`String`	`getSymbol()`	Gets the symbol value
`int`	`hashCode()`
`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(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 String getSymbol()
```
    Gets the symbol value
    
    Returns:
    
    the symbol.
  - equals
```
public boolean equals(Object o)
```
    Will compare equal to a String that is equal to the String that this holds
    
    Overrides:
    
    equals in class 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 Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object