com.dyuproject.protostuff

Class JsonXOutput

java.lang.Object

com.dyuproject.protostuff.WriteSession

com.dyuproject.protostuff.JsonXOutput

All Implemented Interfaces:

Output, StatefulOutput

public final class JsonXOutput
extends WriteSession
implements StatefulOutput

An optimized json output which is efficient in writing numeric keys and pre-encoded utf8 strings (in byte array form). This is the appropriate output sink to use when writing from binary (protostuff,protobuf,etc) pipes.

Author:

David Yu

Date created:

Jul 2, 2010

Nested Class Summary

Nested classes/interfaces inherited from class com.dyuproject.protostuff.WriteSession

WriteSession.FlushHandler

Field Summary

Fields inherited from class com.dyuproject.protostuff.WriteSession

flushHandler, head, nextBufferSize, out, sink, size, tail

Constructor Summary

Constructors

Constructor and Description
JsonXOutput(LinkedBuffer head, int flags, Schema<?> schema)
JsonXOutput(LinkedBuffer head, java.io.OutputStream out, int flags, Schema<?> schema)
JsonXOutput(LinkedBuffer head, java.io.OutputStream out, WriteSession.FlushHandler flushHandler, int nextBufferSize, int flags, Schema<?> schema)

Method Summary

Modifier and Type	Method and Description
JsonXOutput	clear()
Schema<?>	currentSchema() Returns the current schema being used.
int	getLastNumber() Gets the last field number written.
boolean	isEnumsByName() Returns whether the outgoing enum values are written using their name instead of number.
boolean	isLastRepeated() Returns true if the last written field was a repeated field.
boolean	isNumeric() Returns whether the outgoing messages' field names are numeric.
void	reset() Resets this output for re-use.
Schema<?>	scope(int fieldNumber, boolean push, Schema<?> schema, boolean repeated) Equivalent to writeObject(int, Object, Schema, boolean) when used like this:
void	updateLast(Schema<?> schema, Schema<?> lastSchema)
JsonXOutput	use(Schema<?> schema) Before serializing a message/object tied to a schema, this should be called.
void	writeBool(int fieldNumber, boolean value, boolean repeated)
void	writeByteArray(int fieldNumber, byte[] value, boolean repeated)
void	writeByteRange(boolean utf8String, int fieldNumber, byte[] value, int offset, int length, boolean repeated)
void	writeBytes(int fieldNumber, ByteString value, boolean repeated)
void	writeDouble(int fieldNumber, double value, boolean repeated)
void	writeEnum(int fieldNumber, int value, boolean repeated)
void	writeEnumFromIdx(int fieldNumber, int idx, EnumMapping mapping, boolean repeated)
void	writeFixed32(int fieldNumber, int value, boolean repeated)
void	writeFixed64(int fieldNumber, long value, boolean repeated)
void	writeFloat(int fieldNumber, float value, boolean repeated)
void	writeInt32(int fieldNumber, int value, boolean repeated)
void	writeInt64(int fieldNumber, long value, boolean repeated)
<T> void	writeObject(int fieldNumber, T value, Schema<T> schema, boolean repeated)
void	writeSFixed32(int fieldNumber, int value, boolean repeated)
void	writeSFixed64(int fieldNumber, long value, boolean repeated)
void	writeSInt32(int fieldNumber, int value, boolean repeated)
void	writeSInt64(int fieldNumber, long value, boolean repeated)
void	writeString(int fieldNumber, java.lang.String value, boolean repeated)
void	writeUInt32(int fieldNumber, int value, boolean repeated)
void	writeUInt64(int fieldNumber, long value, boolean repeated)

Methods inherited from class com.dyuproject.protostuff.WriteSession

flush, flush, flush, getSize, toByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonXOutput

public JsonXOutput(LinkedBuffer head,
                   int flags,
                   Schema<?> schema)

JsonXOutput

public JsonXOutput(LinkedBuffer head,
                   java.io.OutputStream out,
                   WriteSession.FlushHandler flushHandler,
                   int nextBufferSize,
                   int flags,
                   Schema<?> schema)

JsonXOutput

public JsonXOutput(LinkedBuffer head,
                   java.io.OutputStream out,
                   int flags,
                   Schema<?> schema)

Method Detail

reset

public void reset()

Resets this output for re-use.

Overrides:

reset in class WriteSession

clear

public JsonXOutput clear()

Overrides:

clear in class WriteSession

use

public JsonXOutput use(Schema<?> schema)

Before serializing a message/object tied to a schema, this should be called.

isEnumsByName

public boolean isEnumsByName()

Returns whether the outgoing enum values are written using their name instead of number.

Specified by:

isEnumsByName in interface Output

isNumeric

public boolean isNumeric()

Returns whether the outgoing messages' field names are numeric.

getLastNumber

public int getLastNumber()

Gets the last field number written.

isLastRepeated

public boolean isLastRepeated()

Returns true if the last written field was a repeated field.

currentSchema

public Schema<?> currentSchema()

Returns the current schema being used.

updateLast

public void updateLast(Schema<?> schema,
                       Schema<?> lastSchema)

Specified by:

updateLast in interface StatefulOutput

writeBool

public void writeBool(int fieldNumber,
                      boolean value,
                      boolean repeated)
               throws java.io.IOException

Specified by:

writeBool in interface Output

Throws:

java.io.IOException

writeByteArray

public void writeByteArray(int fieldNumber,
                           byte[] value,
                           boolean repeated)
                    throws java.io.IOException

Specified by:

writeByteArray in interface Output

Throws:

java.io.IOException

writeByteRange

public void writeByteRange(boolean utf8String,
                           int fieldNumber,
                           byte[] value,
                           int offset,
                           int length,
                           boolean repeated)
                    throws java.io.IOException

Specified by:

writeByteRange in interface Output

Throws:

java.io.IOException

writeBytes

public void writeBytes(int fieldNumber,
                       ByteString value,
                       boolean repeated)
                throws java.io.IOException

Specified by:

writeBytes in interface Output

Throws:

java.io.IOException

writeDouble

public void writeDouble(int fieldNumber,
                        double value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeDouble in interface Output

Throws:

java.io.IOException

writeEnum

public void writeEnum(int fieldNumber,
                      int value,
                      boolean repeated)
               throws java.io.IOException

Specified by:

writeEnum in interface Output

Throws:

java.io.IOException

writeEnumFromIdx

public void writeEnumFromIdx(int fieldNumber,
                             int idx,
                             EnumMapping mapping,
                             boolean repeated)
                      throws java.io.IOException

Specified by:

writeEnumFromIdx in interface Output

Throws:

java.io.IOException

writeFixed32

public void writeFixed32(int fieldNumber,
                         int value,
                         boolean repeated)
                  throws java.io.IOException

Specified by:

writeFixed32 in interface Output

Throws:

java.io.IOException

writeFixed64

public void writeFixed64(int fieldNumber,
                         long value,
                         boolean repeated)
                  throws java.io.IOException

Specified by:

writeFixed64 in interface Output

Throws:

java.io.IOException

writeFloat

public void writeFloat(int fieldNumber,
                       float value,
                       boolean repeated)
                throws java.io.IOException

Specified by:

writeFloat in interface Output

Throws:

java.io.IOException

writeInt32

public void writeInt32(int fieldNumber,
                       int value,
                       boolean repeated)
                throws java.io.IOException

Specified by:

writeInt32 in interface Output

Throws:

java.io.IOException

writeInt64

public void writeInt64(int fieldNumber,
                       long value,
                       boolean repeated)
                throws java.io.IOException

Specified by:

writeInt64 in interface Output

Throws:

java.io.IOException

writeSFixed32

public void writeSFixed32(int fieldNumber,
                          int value,
                          boolean repeated)
                   throws java.io.IOException

Specified by:

writeSFixed32 in interface Output

Throws:

java.io.IOException

writeSFixed64

public void writeSFixed64(int fieldNumber,
                          long value,
                          boolean repeated)
                   throws java.io.IOException

Specified by:

writeSFixed64 in interface Output

Throws:

java.io.IOException

writeSInt32

public void writeSInt32(int fieldNumber,
                        int value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeSInt32 in interface Output

Throws:

java.io.IOException

writeSInt64

public void writeSInt64(int fieldNumber,
                        long value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeSInt64 in interface Output

Throws:

java.io.IOException

writeString

public void writeString(int fieldNumber,
                        java.lang.String value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeString in interface Output

Throws:

java.io.IOException

writeUInt32

public void writeUInt32(int fieldNumber,
                        int value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeUInt32 in interface Output

Throws:

java.io.IOException

writeUInt64

public void writeUInt64(int fieldNumber,
                        long value,
                        boolean repeated)
                 throws java.io.IOException

Specified by:

writeUInt64 in interface Output

Throws:

java.io.IOException

writeObject

public <T> void writeObject(int fieldNumber,
                            T value,
                            Schema<T> schema,
                            boolean repeated)
                     throws java.io.IOException

Specified by:

writeObject in interface Output

Throws:

java.io.IOException

scope

public Schema<?> scope(int fieldNumber,
                       boolean push,
                       Schema<?> schema,
                       boolean repeated)
                throws java.io.IOException

Equivalent to writeObject(int, Object, Schema, boolean) when used like this:

 
 Schema prevSchema = output.scope(1, true, pipeSchema, false);
 pipeSchema.writeTo(output, pipe);
 output.scope(1, false, prevSchema, false);
 

Throws:

java.io.IOException