Package org.bson

Class BsonString

java.lang.Object

org.bson.BsonValue

org.bson.BsonString

All Implemented Interfaces:

java.lang.Comparable<BsonString>

public class BsonString
extends BsonValue
implements java.lang.Comparable<BsonString>

A representation of the BSON String type.

Since:

3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	compareTo(BsonString o)
boolean	equals(java.lang.Object o)
BsonType	getBsonType() Gets the BSON type of this value.
java.lang.String	getValue() Gets the String 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

BsonString

public BsonString(java.lang.String value)

Construct a new instance with the given value.

Parameters:

value - the non-null value

Method Detail

compareTo

public int compareTo(BsonString o)

Specified by:

compareTo in interface java.lang.Comparable<BsonString>

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)

getValue

public java.lang.String getValue()

Gets the String value.

Returns:

the value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object