Package org.apache.thrift.protocol

Class TProtocolDecorator

java.lang.Object

org.apache.thrift.protocol.TProtocol

org.apache.thrift.protocol.TProtocolDecorator

All Implemented Interfaces:

TReadProtocol, TWriteProtocol

Direct Known Subclasses:

TLegacyUuidProtocolDecorator, TMultiplexedProtocol

public abstract class TProtocolDecorator
extends TProtocol

TProtocolDecorator forwards all requests to an enclosed TProtocol instance, providing a way to author concise concrete decorator subclasses. While it has no abstract methods, it is marked abstract as a reminder that by itself, it does not modify the behaviour of the enclosed TProtocol.

See p.175 of Design Patterns (by Gamma et al.)

See Also:

• TMultiplexedProtocol

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.thrift.protocol.TProtocol

TProtocol.ReadCallback<T,R>, TProtocol.ReadCollectionCallback<R>, TProtocol.ReadMapEntryCallback<K,V>, TProtocol.WriteCallback<T>

Field Summary

Fields inherited from class org.apache.thrift.protocol.TProtocol

skippedBytes, trans_

Constructor Summary

Constructors

Constructor	Description
TProtocolDecorator(TProtocol protocol)	Encloses the specified protocol.

Method Summary

Modifier and Type	Method	Description
int	getMinSerializedSize(byte type)	Return min serialized size in bytes
ByteBuffer	readBinary()
boolean	readBool()
byte	readByte()
double	readDouble()
TField	readFieldBegin()
int	readFieldBeginData()
void	readFieldEnd()
short	readI16()
int	readI32()
long	readI64()
TList	readListBegin()
void	readListEnd()
TMap	readMapBegin()
void	readMapEnd()
TMessage	readMessageBegin()
void	readMessageEnd()
TSet	readSetBegin()
void	readSetEnd()
String	readString()
TStruct	readStructBegin()
void	readStructEnd()
UUID	readUuid()
void	reset()	Reset any internal state back to a blank slate.
protected void	skipBinary()
protected void	skipBool()	The default implementation of all skip() methods calls the corresponding read() method.
protected void	skipByte()
protected void	skipDouble()
protected void	skipI16()
protected void	skipI32()
protected void	skipI64()
void	writeBinary(ByteBuffer buf)
void	writeBool(boolean b)
void	writeByte(byte b)
void	writeDouble(double v)
void	writeFieldBegin(TField tField)
void	writeFieldEnd()
void	writeFieldStop()
void	writeI16(short i)
void	writeI32(int i)
void	writeI64(long l)
void	writeListBegin(TList tList)
void	writeListEnd()
void	writeMapBegin(TMap tMap)
void	writeMapEnd()
void	writeMessageBegin(TMessage tMessage)
void	writeMessageEnd()
void	writeSetBegin(TSet tSet)
void	writeSetEnd()
void	writeString(String s)
void	writeStructBegin(TStruct tStruct)
void	writeStructEnd()
void	writeUuid(UUID uuid)

Methods inherited from class org.apache.thrift.protocol.TProtocol

checkReadBytesAvailable, checkReadBytesAvailable, checkReadBytesAvailable, decrementRecursionDepth, getScheme, getTransport, incrementRecursionDepth, readField, readList, readList, readList, readMap, readMap, readMap, readMap, readMap, readMessage, readSet, readSet, readSet, readStruct, skip, skip, skipBytes, writeField, writeList, writeMap, writeMessage, writeSet, writeStruct

Methods inherited from class java.lang.Object

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

Constructor Details

TProtocolDecorator

public TProtocolDecorator(TProtocol protocol)

Encloses the specified protocol.

Parameters:

protocol - All operations will be forward to this protocol. Must be non-null.

Method Details

writeMessageBegin

public void writeMessageBegin(TMessage tMessage)
                       throws TException

Throws:

TException

writeMessageEnd

public void writeMessageEnd()
                     throws TException

Throws:

TException

writeStructBegin

public void writeStructBegin(TStruct tStruct)
                      throws TException

Throws:

TException

readUuid

public UUID readUuid()
              throws TException

Throws:

TException

writeUuid

public void writeUuid(UUID uuid)
               throws TException

Throws:

TException

writeStructEnd

public void writeStructEnd()
                    throws TException

Throws:

TException

writeFieldBegin

public void writeFieldBegin(TField tField)
                     throws TException

Throws:

TException

writeFieldEnd

public void writeFieldEnd()
                   throws TException

Throws:

TException

writeFieldStop

public void writeFieldStop()
                    throws TException

Throws:

TException

writeMapBegin

public void writeMapBegin(TMap tMap)
                   throws TException

Throws:

TException

writeMapEnd

public void writeMapEnd()
                 throws TException

Throws:

TException

writeListBegin

public void writeListBegin(TList tList)
                    throws TException

Throws:

TException

writeListEnd

public void writeListEnd()
                  throws TException

Throws:

TException

writeSetBegin

public void writeSetBegin(TSet tSet)
                   throws TException

Throws:

TException

writeSetEnd

public void writeSetEnd()
                 throws TException

Throws:

TException

writeBool

public void writeBool(boolean b)
               throws TException

Throws:

TException

writeByte

public void writeByte(byte b)
               throws TException

Throws:

TException

writeI16

public void writeI16(short i)
              throws TException

Throws:

TException

writeI32

public void writeI32(int i)
              throws TException

Throws:

TException

writeI64

public void writeI64(long l)
              throws TException

Throws:

TException

writeDouble

public void writeDouble(double v)
                 throws TException

Throws:

TException

writeString

public void writeString(String s)
                 throws TException

Throws:

TException

writeBinary

public void writeBinary(ByteBuffer buf)
                 throws TException

Throws:

TException

readMessageBegin

public TMessage readMessageBegin()
                          throws TException

Throws:

TException

readMessageEnd

public void readMessageEnd()
                    throws TException

Throws:

TException

readStructBegin

public TStruct readStructBegin()
                        throws TException

Throws:

TException

readStructEnd

public void readStructEnd()
                   throws TException

Throws:

TException

readFieldBegin

public TField readFieldBegin()
                      throws TException

Throws:

TException

readFieldEnd

public void readFieldEnd()
                  throws TException

Throws:

TException

readMapBegin

public TMap readMapBegin()
                  throws TException

Throws:

TException

readMapEnd

public void readMapEnd()
                throws TException

Throws:

TException

readListBegin

public TList readListBegin()
                    throws TException

Throws:

TException

readListEnd

public void readListEnd()
                 throws TException

Throws:

TException

readSetBegin

public TSet readSetBegin()
                  throws TException

Throws:

TException

readSetEnd

public void readSetEnd()
                throws TException

Throws:

TException

readBool

public boolean readBool()
                 throws TException

Throws:

TException

readByte

public byte readByte()
              throws TException

Throws:

TException

readI16

public short readI16()
              throws TException

Throws:

TException

readI32

public int readI32()
            throws TException

Throws:

TException

readI64

public long readI64()
             throws TException

Throws:

TException

readDouble

public double readDouble()
                  throws TException

Throws:

TException

readString

public String readString()
                  throws TException

Throws:

TException

readBinary

public ByteBuffer readBinary()
                      throws TException

Throws:

TException

readFieldBeginData

public int readFieldBeginData()
                       throws TException

Overrides:

readFieldBeginData in class TProtocol

Throws:

TException

skipBool

protected void skipBool()
                 throws TException

Description copied from class: TProtocol

The default implementation of all skip() methods calls the corresponding read() method. Protocols that derive from this class are strongly encouraged to provide a more efficient alternative.

Overrides:

skipBool in class TProtocol

Throws:

TException

skipByte

protected void skipByte()
                 throws TException

Overrides:

skipByte in class TProtocol

Throws:

TException

skipI16

protected void skipI16()
                throws TException

Overrides:

skipI16 in class TProtocol

Throws:

TException

skipI32

protected void skipI32()
                throws TException

Overrides:

skipI32 in class TProtocol

Throws:

TException

skipI64

protected void skipI64()
                throws TException

Overrides:

skipI64 in class TProtocol

Throws:

TException

skipDouble

protected void skipDouble()
                   throws TException

Overrides:

skipDouble in class TProtocol

Throws:

TException

skipBinary

protected void skipBinary()
                   throws TException

Overrides:

skipBinary in class TProtocol

Throws:

TException

getMinSerializedSize

public int getMinSerializedSize(byte type)
                         throws TException

Description copied from class: TProtocol

Return min serialized size in bytes

Specified by:

getMinSerializedSize in class TProtocol

Parameters:

type - Returns the minimum amount of bytes needed to store the smallest possible instance of TType.

Returns:

size

Throws:

TException - if underlying protocol throws

reset

public void reset()

Description copied from class: TProtocol

Reset any internal state back to a blank slate. This method only needs to be implemented for stateful protocols.

Overrides:

reset in class TProtocol