Package org.bson.codecs

Class StringCodec

java.lang.Object

org.bson.codecs.StringCodec

All Implemented Interfaces:

Codec<String>, Decoder<String>, Encoder<String>, RepresentationConfigurable<String>

public class StringCodec
extends Object
implements Codec<String>, RepresentationConfigurable<String>

Encodes and decodes String objects.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
StringCodec()	Constructs a StringCodec with a String representation.

Method Summary

Modifier and Type	Method	Description
String	decode(BsonReader reader, DecoderContext decoderContext)	Decodes a BSON value from the given reader into an instance of the type parameter T.
void	encode(BsonWriter writer, String value, EncoderContext encoderContext)	Encode an instance of the type parameter T into a BSON value.
Class<String>	getEncoderClass()	Returns the Class instance that this encodes.
BsonType	getRepresentation()	Gets the BsonRepresentation.
Codec<String>	withRepresentation(BsonType representation)	Returns an immutable codec with the given representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringCodec

public StringCodec()

Constructs a StringCodec with a String representation.

Method Detail

getRepresentation

public BsonType getRepresentation()

Description copied from interface: RepresentationConfigurable

Gets the BsonRepresentation.

Specified by:

getRepresentation in interface RepresentationConfigurable<String>

Returns:

the BsonRepresentation

withRepresentation

public Codec<String> withRepresentation(BsonType representation)

Description copied from interface: RepresentationConfigurable

Returns an immutable codec with the given representation. If the provided representation is not supported an exception will be thrown.

Specified by:

withRepresentation in interface RepresentationConfigurable<String>

Parameters:

representation - the BsonRepresentation.

Returns:

a new Codec with the correct representation.

encode

public void encode(BsonWriter writer,
                   String value,
                   EncoderContext encoderContext)

Description copied from interface: Encoder

Encode an instance of the type parameter T into a BSON value.

Specified by:

encode in interface Encoder<String>

Parameters:

writer - the BSON writer to encode into

value - the value to encode

encoderContext - the encoder context

decode

public String decode(BsonReader reader,
                     DecoderContext decoderContext)

Description copied from interface: Decoder

Decodes a BSON value from the given reader into an instance of the type parameter T.

Specified by:

decode in interface Decoder<String>

Parameters:

reader - the BSON reader

decoderContext - the decoder context

Returns:

an instance of the type parameter T.

getEncoderClass

public Class<String> getEncoderClass()

Description copied from interface: Encoder

Returns the Class instance that this encodes. This is necessary because Java does not reify generic types.

Specified by:

getEncoderClass in interface Encoder<String>

Returns:

the Class instance that this encodes.