Class YamlOutput

java.lang.Object

io.protostuff.WriteSession

io.protostuff.YamlOutput

All Implemented Interfaces:

Output, StatefulOutput

public final class YamlOutput
extends WriteSession
implements Output, StatefulOutput

An output used for writing data with yaml format.

Author:

David Yu

Nested Class Summary

Nested classes/interfaces inherited from class WriteSession

WriteSession.FlushHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXTRA_INDENT	The extra indention for the yaml output.
static final int	LINE_BREAK_LEN	Returns 2 if line break is using CRLF ("\r\n"), 1 if using LF ("\n")

Fields inherited from class WriteSession

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

Constructor Summary

Constructors

Constructor	Description
YamlOutput(LinkedBuffer buffer, Schema<?> schema)
YamlOutput(LinkedBuffer buffer, OutputStream out, Schema<?> schema)
YamlOutput(LinkedBuffer buffer, OutputStream out, WriteSession.FlushHandler flushHandler, int nextBufferSize, Schema<?> schema)

Method Summary

Modifier and Type	Method	Description
YamlOutput	clear()	The buffer will be cleared (tail will point to the head) and the size will be reset to zero.
void	reset()	Resets this output for re-use.
void	updateLast(Schema<?> schema, Schema<?> lastSchema)	Updates the schema if lastSchema was indeed the last schema used.
YamlOutput	use(Schema<?> schema)	Before serializing a message/object tied to a schema, this should be called.
void	writeBool(int fieldNumber, boolean value, boolean repeated)	Writes a boolean field.
void	writeByteArray(int fieldNumber, byte[] value, boolean repeated)	Writes a byte array field.
void	writeByteRange(boolean utf8String, int fieldNumber, byte[] value, int offset, int length, boolean repeated)	Writes a binary or a pre-encoded utf8 string.
void	writeBytes(int fieldNumber, ByteString value, boolean repeated)	Writes a ByteString(wraps byte array) field.
void	writeBytes(int fieldNumber, ByteBuffer value, boolean repeated)	Writes a ByteBuffer field.
void	writeDouble(int fieldNumber, double value, boolean repeated)	Writes a double field.
void	writeEnum(int fieldNumber, int value, boolean repeated)	Writes a enum(its number) field.
void	writeFixed32(int fieldNumber, int value, boolean repeated)	Writes a fixed int(4 bytes) field.
void	writeFixed64(int fieldNumber, long value, boolean repeated)	Writes a fixed long(8 bytes) field.
void	writeFloat(int fieldNumber, float value, boolean repeated)	Writes a float field.
void	writeInt32(int fieldNumber, int value, boolean repeated)	Writes a variable int field.
void	writeInt64(int fieldNumber, long value, boolean repeated)	Writes a variable long field.
<T> void	writeObject(int fieldNumber, T value, Schema<T> schema, boolean repeated)	Writes an object(using its schema) field.
void	writeSFixed32(int fieldNumber, int value, boolean repeated)	Writes a signed+fixed int(4 bytes) field.
void	writeSFixed64(int fieldNumber, long value, boolean repeated)	Writes a signed+fixed long(8 bytes) field.
void	writeSInt32(int fieldNumber, int value, boolean repeated)	Writes a signed int field.
void	writeSInt64(int fieldNumber, long value, boolean repeated)	Writes a signed long field.
void	writeString(int fieldNumber, CharSequence value, boolean repeated)	Writes a String field.
void	writeUInt32(int fieldNumber, int value, boolean repeated)	Writes an unsigned int field.
void	writeUInt64(int fieldNumber, long value, boolean repeated)	Writes an unsigned long field.

Methods inherited from class WriteSession

flush, flush, flush, getSize, toByteArray

Methods inherited from class Object

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

Field Details

LINE_BREAK_LEN

public static final int LINE_BREAK_LEN

Returns 2 if line break is using CRLF ("\r\n"), 1 if using LF ("\n")

EXTRA_INDENT

public static final int EXTRA_INDENT

The extra indention for the yaml output. (Increases readability)

Constructor Details

YamlOutput

public YamlOutput(LinkedBuffer buffer,
 Schema<?> schema)

YamlOutput

public YamlOutput(LinkedBuffer buffer,
 OutputStream out,
 WriteSession.FlushHandler flushHandler,
 int nextBufferSize,
 Schema<?> schema)

YamlOutput

public YamlOutput(LinkedBuffer buffer,
 OutputStream out,
 Schema<?> schema)

Method Details

reset

public void reset()

Resets this output for re-use.

Overrides:

reset in class WriteSession

clear

public YamlOutput clear()

Description copied from class: WriteSession

The buffer will be cleared (tail will point to the head) and the size will be reset to zero.

Overrides:

clear in class WriteSession

use

public YamlOutput use(Schema<?> schema)

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

updateLast

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

Description copied from interface: StatefulOutput

Updates the schema if lastSchema was indeed the last schema used.

Specified by:

updateLast in interface StatefulOutput

writeBool

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

Description copied from interface: Output

Writes a boolean field.

Specified by:

writeBool in interface Output

Throws:

IOException

writeDouble

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

Description copied from interface: Output

Writes a double field.

Specified by:

writeDouble in interface Output

Throws:

IOException

writeFloat

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

Description copied from interface: Output

Writes a float field.

Specified by:

writeFloat in interface Output

Throws:

IOException

writeEnum

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

Description copied from interface: Output

Writes a enum(its number) field.

Specified by:

writeEnum in interface Output

Throws:

IOException

writeFixed32

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

Description copied from interface: Output

Writes a fixed int(4 bytes) field.

Specified by:

writeFixed32 in interface Output

Throws:

IOException

writeInt32

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

Description copied from interface: Output

Writes a variable int field.

Specified by:

writeInt32 in interface Output

Throws:

IOException

writeSFixed32

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

Description copied from interface: Output

Writes a signed+fixed int(4 bytes) field.

Specified by:

writeSFixed32 in interface Output

Throws:

IOException

writeUInt32

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

Description copied from interface: Output

Writes an unsigned int field.

Specified by:

writeUInt32 in interface Output

Throws:

IOException

writeSInt32

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

Description copied from interface: Output

Writes a signed int field.

Specified by:

writeSInt32 in interface Output

Throws:

IOException

writeFixed64

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

Description copied from interface: Output

Writes a fixed long(8 bytes) field.

Specified by:

writeFixed64 in interface Output

Throws:

IOException

writeInt64

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

Description copied from interface: Output

Writes a variable long field.

Specified by:

writeInt64 in interface Output

Throws:

IOException

writeSFixed64

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

Description copied from interface: Output

Writes a signed+fixed long(8 bytes) field.

Specified by:

writeSFixed64 in interface Output

Throws:

IOException

writeSInt64

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

Description copied from interface: Output

Writes a signed long field.

Specified by:

writeSInt64 in interface Output

Throws:

IOException

writeUInt64

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

Description copied from interface: Output

Writes an unsigned long field.

Specified by:

writeUInt64 in interface Output

Throws:

IOException

writeString

public void writeString(int fieldNumber,
 CharSequence value,
 boolean repeated)
                 throws IOException

Description copied from interface: Output

Writes a String field.

Specified by:

writeString in interface Output

Throws:

IOException

writeBytes

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

Description copied from interface: Output

Writes a ByteString(wraps byte array) field.

Specified by:

writeBytes in interface Output

Throws:

IOException

writeByteArray

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

Description copied from interface: Output

Writes a byte array field.

Specified by:

writeByteArray in interface Output

Throws:

IOException

writeByteRange

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

Description copied from interface: Output

Writes a binary or a pre-encoded utf8 string.

Specified by:

writeByteRange in interface Output

Throws:

IOException

writeObject

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

Description copied from interface: Output

Writes an object(using its schema) field.

Specified by:

writeObject in interface Output

Throws:

IOException

writeBytes

public void writeBytes(int fieldNumber,
 ByteBuffer value,
 boolean repeated)
                throws IOException

Writes a ByteBuffer field.

Specified by:

writeBytes in interface Output

Throws:

IOException