org.glassfish.tyrus.core.coder

Class NoOpTextCoder

java.lang.Object

org.glassfish.tyrus.core.coder.CoderAdapter

org.glassfish.tyrus.core.coder.NoOpTextCoder

All Implemented Interfaces:

Decoder, Decoder.Text<java.lang.String>, Encoder, Encoder.Text<java.lang.String>

public class NoOpTextCoder
extends CoderAdapter
implements Decoder.Text<java.lang.String>, Encoder.Text<java.lang.String>

Author:

Stepan Kopriva (stepan.kopriva at oracle.com)

Nested Class Summary

Nested classes/interfaces inherited from interface javax.websocket.Decoder

Decoder.Binary<T>, Decoder.BinaryStream<T>, Decoder.Text<T>, Decoder.TextStream<T>

Nested classes/interfaces inherited from interface javax.websocket.Encoder

Encoder.Binary<T>, Encoder.BinaryStream<T>, Encoder.Text<T>, Encoder.TextStream<T>

Constructor Summary

Constructors

Constructor and Description
NoOpTextCoder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	decode(java.lang.String s) Decode the given String into an object of type T.
java.lang.String	encode(java.lang.String object) Encode the given object into a String.
boolean	willDecode(java.lang.String s) Answer whether the given String can be decoded into an object of type T.

Methods inherited from class org.glassfish.tyrus.core.coder.CoderAdapter

destroy, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.websocket.Decoder

destroy, init

Methods inherited from interface javax.websocket.Encoder

destroy, init

Constructor Detail

NoOpTextCoder

public NoOpTextCoder()

Method Detail

willDecode

public boolean willDecode(java.lang.String s)

Description copied from interface: Decoder.Text

Answer whether the given String can be decoded into an object of type T.

Specified by:

willDecode in interface Decoder.Text<java.lang.String>

Parameters:

s - the string being tested for decodability.

Returns:

whether this decoder can decoded the supplied string.

decode

public java.lang.String decode(java.lang.String s)
                        throws DecodeException

Description copied from interface: Decoder.Text

Decode the given String into an object of type T.

Specified by:

decode in interface Decoder.Text<java.lang.String>

Parameters:

s - string to be decoded.

Returns:

the decoded message as an object of type T

Throws:

DecodeException - If the provided string cannot be decoded to type T

encode

public java.lang.String encode(java.lang.String object)
                        throws EncodeException

Description copied from interface: Encoder.Text

Encode the given object into a String.

Specified by:

encode in interface Encoder.Text<java.lang.String>

Parameters:

object - the object being encoded.

Returns:

the encoded object as a string.

Throws:

EncodeException - The provided object could not be encoded as a string