com.foursquare.common.thrift.json

Class TReadableJSONProtocol

java.lang.Object

org.apache.thrift.protocol.TProtocol

com.foursquare.common.thrift.json.TReadableJSONProtocol

All Implemented Interfaces:

com.foursquare.common.thrift.base.SerializeDatesAsSeconds

public class TReadableJSONProtocol
extends org.apache.thrift.protocol.TProtocol
implements com.foursquare.common.thrift.base.SerializeDatesAsSeconds

Thrift protocol to read and write (optionally pretty) JSON. Differs from Thrift's TJSONProtocol in that TReadableJSONProtocol uses the actual field names instead of the raw field tag numbers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TReadableJSONProtocol.Factory Factory class for creating TReadableJSONProtocol objects.

Field Summary

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

trans_

Constructor Summary

Constructors

Constructor and Description
TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans, org.codehaus.jackson.PrettyPrinter pp)
TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans, org.codehaus.jackson.PrettyPrinter pp, org.codehaus.jackson.JsonParser jp)
TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans, org.codehaus.jackson.PrettyPrinter pp, org.codehaus.jackson.JsonParser jp, boolean coerceMapKeys)
TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans, org.codehaus.jackson.PrettyPrinter pp, org.codehaus.jackson.JsonParser jp, boolean coerceMapKeys, boolean bareObjectIds)

Method Summary

Methods

Modifier and Type	Method and Description
static byte	getElemTypeFromToken(org.codehaus.jackson.JsonToken token)
java.nio.ByteBuffer	readBinary()
boolean	readBool()
byte	readByte()
double	readDouble()
org.apache.thrift.protocol.TField	readFieldBegin()
void	readFieldEnd()
short	readI16()
int	readI32()
long	readI64()
org.apache.thrift.protocol.TList	readListBegin()
byte[]	readListBeginEnhanced() Similar to readListBegin but returns an array with the type of each element in the list, instead of returning a TList.
void	readListEnd()
org.apache.thrift.protocol.TMap	readMapBegin() IMPORTANT: Only string keyed maps are supported.
void	readMapEnd()
org.apache.thrift.protocol.TMessage	readMessageBegin() Reading methods.
void	readMessageEnd()
org.apache.thrift.protocol.TSet	readSetBegin()
void	readSetEnd()
java.lang.String	readString()
org.apache.thrift.protocol.TStruct	readStructBegin()
void	readStructEnd()
void	reset() Reset any internal state back to a blank slate.
void	writeBinary(java.nio.ByteBuffer bb)
void	writeBool(boolean b)
void	writeByte(byte b)
void	writeDouble(double v)
void	writeFieldBegin(org.apache.thrift.protocol.TField tField)
void	writeFieldEnd()
void	writeFieldStop()
void	writeI16(short i)
void	writeI32(int i)
void	writeI64(long l)
void	writeListBegin(org.apache.thrift.protocol.TList tList)
void	writeListEnd()
void	writeMapBegin(org.apache.thrift.protocol.TMap tMap)
void	writeMapEnd()
void	writeMessageBegin(org.apache.thrift.protocol.TMessage tMessage) Writing methods.
void	writeMessageEnd()
void	writeSetBegin(org.apache.thrift.protocol.TSet tSet)
void	writeSetEnd()
void	writeString(java.lang.String s)
void	writeStructBegin(org.apache.thrift.protocol.TStruct tStruct)
void	writeStructEnd()

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

getScheme, getTransport

Methods inherited from class java.lang.Object

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

Constructor Detail

TReadableJSONProtocol

public TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans,
                     org.codehaus.jackson.PrettyPrinter pp)

TReadableJSONProtocol

public TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans,
                     org.codehaus.jackson.PrettyPrinter pp,
                     org.codehaus.jackson.JsonParser jp)

TReadableJSONProtocol

public TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans,
                     org.codehaus.jackson.PrettyPrinter pp,
                     org.codehaus.jackson.JsonParser jp,
                     boolean coerceMapKeys)

TReadableJSONProtocol

public TReadableJSONProtocol(org.apache.thrift.transport.TTransport trans,
                     org.codehaus.jackson.PrettyPrinter pp,
                     org.codehaus.jackson.JsonParser jp,
                     boolean coerceMapKeys,
                     boolean bareObjectIds)

Method Detail

getElemTypeFromToken

public static byte getElemTypeFromToken(org.codehaus.jackson.JsonToken token)
                                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

reset

public void reset()

Description copied from class: org.apache.thrift.protocol.TProtocol

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

Overrides:

reset in class org.apache.thrift.protocol.TProtocol

writeMessageBegin

public void writeMessageBegin(org.apache.thrift.protocol.TMessage tMessage)
                       throws org.apache.thrift.TException

Description copied from class: org.apache.thrift.protocol.TProtocol

Writing methods.

Specified by:

writeMessageBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeMessageEnd

public void writeMessageEnd()
                     throws org.apache.thrift.TException

Specified by:

writeMessageEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeStructBegin

public void writeStructBegin(org.apache.thrift.protocol.TStruct tStruct)
                      throws org.apache.thrift.TException

Specified by:

writeStructBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeStructEnd

public void writeStructEnd()
                    throws org.apache.thrift.TException

Specified by:

writeStructEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldBegin

public void writeFieldBegin(org.apache.thrift.protocol.TField tField)
                     throws org.apache.thrift.TException

Specified by:

writeFieldBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldEnd

public void writeFieldEnd()
                   throws org.apache.thrift.TException

Specified by:

writeFieldEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeFieldStop

public void writeFieldStop()
                    throws org.apache.thrift.TException

Specified by:

writeFieldStop in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeMapBegin

public void writeMapBegin(org.apache.thrift.protocol.TMap tMap)
                   throws org.apache.thrift.TException

Specified by:

writeMapBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeMapEnd

public void writeMapEnd()
                 throws org.apache.thrift.TException

Specified by:

writeMapEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeListBegin

public void writeListBegin(org.apache.thrift.protocol.TList tList)
                    throws org.apache.thrift.TException

Specified by:

writeListBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeListEnd

public void writeListEnd()
                  throws org.apache.thrift.TException

Specified by:

writeListEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeSetBegin

public void writeSetBegin(org.apache.thrift.protocol.TSet tSet)
                   throws org.apache.thrift.TException

Specified by:

writeSetBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeSetEnd

public void writeSetEnd()
                 throws org.apache.thrift.TException

Specified by:

writeSetEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeBool

public void writeBool(boolean b)
               throws org.apache.thrift.TException

Specified by:

writeBool in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeByte

public void writeByte(byte b)
               throws org.apache.thrift.TException

Specified by:

writeByte in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI16

public void writeI16(short i)
              throws org.apache.thrift.TException

Specified by:

writeI16 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI32

public void writeI32(int i)
              throws org.apache.thrift.TException

Specified by:

writeI32 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeI64

public void writeI64(long l)
              throws org.apache.thrift.TException

Specified by:

writeI64 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeDouble

public void writeDouble(double v)
                 throws org.apache.thrift.TException

Specified by:

writeDouble in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeString

public void writeString(java.lang.String s)
                 throws org.apache.thrift.TException

Specified by:

writeString in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

writeBinary

public void writeBinary(java.nio.ByteBuffer bb)
                 throws org.apache.thrift.TException

Specified by:

writeBinary in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMessageBegin

public org.apache.thrift.protocol.TMessage readMessageBegin()
                                                     throws org.apache.thrift.TException

Description copied from class: org.apache.thrift.protocol.TProtocol

Reading methods.

Specified by:

readMessageBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMessageEnd

public void readMessageEnd()
                    throws org.apache.thrift.TException

Specified by:

readMessageEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readStructBegin

public org.apache.thrift.protocol.TStruct readStructBegin()
                                                   throws org.apache.thrift.TException

Specified by:

readStructBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readStructEnd

public void readStructEnd()
                   throws org.apache.thrift.TException

Specified by:

readStructEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readFieldBegin

public org.apache.thrift.protocol.TField readFieldBegin()
                                                 throws org.apache.thrift.TException

Specified by:

readFieldBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readFieldEnd

public void readFieldEnd()
                  throws org.apache.thrift.TException

Specified by:

readFieldEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMapBegin

public org.apache.thrift.protocol.TMap readMapBegin()
                                             throws org.apache.thrift.TException

IMPORTANT: Only string keyed maps are supported.

Specified by:

readMapBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readMapEnd

public void readMapEnd()
                throws org.apache.thrift.TException

Specified by:

readMapEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readListBegin

public org.apache.thrift.protocol.TList readListBegin()
                                               throws org.apache.thrift.TException

Specified by:

readListBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readListBeginEnhanced

public byte[] readListBeginEnhanced()
                             throws org.apache.thrift.TException

Similar to readListBegin but returns an array with the type of each element in the list, instead of returning a TList.

Returns:

type of every element

Throws:

org.apache.thrift.TException

readListEnd

public void readListEnd()
                 throws org.apache.thrift.TException

Specified by:

readListEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readSetBegin

public org.apache.thrift.protocol.TSet readSetBegin()
                                             throws org.apache.thrift.TException

Specified by:

readSetBegin in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readSetEnd

public void readSetEnd()
                throws org.apache.thrift.TException

Specified by:

readSetEnd in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readBool

public boolean readBool()
                 throws org.apache.thrift.TException

Specified by:

readBool in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readByte

public byte readByte()
              throws org.apache.thrift.TException

Specified by:

readByte in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI16

public short readI16()
              throws org.apache.thrift.TException

Specified by:

readI16 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI32

public int readI32()
            throws org.apache.thrift.TException

Specified by:

readI32 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readI64

public long readI64()
             throws org.apache.thrift.TException

Specified by:

readI64 in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readDouble

public double readDouble()
                  throws org.apache.thrift.TException

Specified by:

readDouble in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readString

public java.lang.String readString()
                            throws org.apache.thrift.TException

Specified by:

readString in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException

readBinary

public java.nio.ByteBuffer readBinary()
                               throws org.apache.thrift.TException

Specified by:

readBinary in class org.apache.thrift.protocol.TProtocol

Throws:

org.apache.thrift.TException