Class CBSerializationContextSize

java.lang.Object

com.io7m.cedarbridge.runtime.api.CBSerializationContextSize

All Implemented Interfaces:

CBSerializationContextErrorType, CBSerializationContextInputType, CBSerializationContextOutputType, CBSerializationContextTracingType, CBSerializationContextType

public final class CBSerializationContextSize
extends Object
implements CBSerializationContextType

A serialization context that writes no data, but calculates the size of all data passing through it.

Constructor Summary

Constructors

Constructor	Description
CBSerializationContextSize()	Construct a context.

Method Summary

Modifier and Type	Method	Description
void	begin(String item)	Begin serializing the given item.
void	begin(String item, int index)	Begin serializing the given item at index index.
void	end(String item)	Finish serializing the given item.
void	end(String item, int index)	Finish serializing the given item at index index.
IOException	errorUnrecognizedVariantCaseClass(Class<?> writerClass, Class<?> clazz)	An unrecognized variant case class was encountered.
IOException	errorUnrecognizedVariantIndex(Class<?> readerClass, int index)	An unrecognized variant index was encountered.
void	flush()	Flush the underlying stream, ensuring any buffered output is written.
ByteBuffer	readByteArray()	Read a byte array.
double	readF16()	Read a floating point 16-bit value
double	readF32()	Read a floating point 32-bit value
double	readF64()	Read a floating point 64-bit value
int	readS16()	Read a signed 16-bit value
int	readS32()	Read a signed 32-bit value
long	readS64()	Read a signed 64-bit value
int	readS8()	Read a signed 8-bit value
int	readSequenceLength()	Read a sequence length
int	readU16()	Read an unsigned 16-bit value
long	readU32()	Read an unsigned 32-bit value
long	readU64()	Read an unsigned 64-bit value
int	readU8()	Read an unsigned 8-bit value
String	readUTF8()	Read a UTF-8 string.
int	readVariantIndex()	Read a variant index
void	reset()	Reset the current size to zero.
long	size()
void	writeByteArray(ByteBuffer x)	Write a byte array value.
void	writeF16(double x)	Write a floating point 16-bit value
void	writeF32(double x)	Write a floating point 32-bit value
void	writeF64(double x)	Write a floating point 64-bit value
void	writeS16(long x)	Write a signed 16-bit value
void	writeS32(long x)	Write a signed 32-bit value
void	writeS64(long x)	Write a signed 64-bit value
void	writeS8(long x)	Write a signed 8-bit value
void	writeSequenceLength(int size)	Write a sequence length
void	writeU16(long x)	Write an unsigned 16-bit value
void	writeU32(long x)	Write an unsigned 32-bit value
void	writeU64(long x)	Write an unsigned 64-bit value
void	writeU8(long x)	Write an unsigned 8-bit value
void	writeUTF8(String x)	Write a UTF-8 string value.
void	writeVariantIndex(int x)	Write a variant index

Methods inherited from class Object

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

Constructor Details

CBSerializationContextSize

public CBSerializationContextSize()

Construct a context.

Method Details

size

public long size()

Returns:

The accumulated size of all data encountered so far

reset

public void reset()

Reset the current size to zero.

readSequenceLength

public int readSequenceLength()

Description copied from interface: CBSerializationContextInputType

Read a sequence length

Specified by:

readSequenceLength in interface CBSerializationContextInputType

Returns:

The length

readVariantIndex

public int readVariantIndex()

Description copied from interface: CBSerializationContextInputType

Read a variant index

Specified by:

readVariantIndex in interface CBSerializationContextInputType

Returns:

The index

readS64

public long readS64()

Description copied from interface: CBSerializationContextInputType

Read a signed 64-bit value

Specified by:

readS64 in interface CBSerializationContextInputType

Returns:

The value

readS32

public int readS32()

Description copied from interface: CBSerializationContextInputType

Read a signed 32-bit value

Specified by:

readS32 in interface CBSerializationContextInputType

Returns:

The value

readS16

public int readS16()

Description copied from interface: CBSerializationContextInputType

Read a signed 16-bit value

Specified by:

readS16 in interface CBSerializationContextInputType

Returns:

The value

readS8

public int readS8()

Description copied from interface: CBSerializationContextInputType

Read a signed 8-bit value

Specified by:

readS8 in interface CBSerializationContextInputType

Returns:

The value

readU64

public long readU64()

Description copied from interface: CBSerializationContextInputType

Read an unsigned 64-bit value

Specified by:

readU64 in interface CBSerializationContextInputType

Returns:

The value

readU32

public long readU32()

Description copied from interface: CBSerializationContextInputType

Read an unsigned 32-bit value

Specified by:

readU32 in interface CBSerializationContextInputType

Returns:

The value

readU16

public int readU16()

Description copied from interface: CBSerializationContextInputType

Read an unsigned 16-bit value

Specified by:

readU16 in interface CBSerializationContextInputType

Returns:

The value

readU8

public int readU8()

Description copied from interface: CBSerializationContextInputType

Read an unsigned 8-bit value

Specified by:

readU8 in interface CBSerializationContextInputType

Returns:

The value

readF64

public double readF64()

Description copied from interface: CBSerializationContextInputType

Read a floating point 64-bit value

Specified by:

readF64 in interface CBSerializationContextInputType

Returns:

The value

readF32

public double readF32()

Description copied from interface: CBSerializationContextInputType

Read a floating point 32-bit value

Specified by:

readF32 in interface CBSerializationContextInputType

Returns:

The value

readF16

public double readF16()

Description copied from interface: CBSerializationContextInputType

Read a floating point 16-bit value

Specified by:

readF16 in interface CBSerializationContextInputType

Returns:

The value

readByteArray

public ByteBuffer readByteArray()

Description copied from interface: CBSerializationContextInputType

Read a byte array.

Specified by:

readByteArray in interface CBSerializationContextInputType

Returns:

The value

readUTF8

public String readUTF8()

Description copied from interface: CBSerializationContextInputType

Read a UTF-8 string.

Specified by:

readUTF8 in interface CBSerializationContextInputType

Returns:

The value

flush

public void flush()

Description copied from interface: CBSerializationContextOutputType

Flush the underlying stream, ensuring any buffered output is written.

Specified by:

flush in interface CBSerializationContextOutputType

writeSequenceLength

public void writeSequenceLength(int size)

Description copied from interface: CBSerializationContextOutputType

Write a sequence length

Specified by:

writeSequenceLength in interface CBSerializationContextOutputType

Parameters:

size - The size

writeVariantIndex

public void writeVariantIndex(int x)

Description copied from interface: CBSerializationContextOutputType

Write a variant index

Specified by:

writeVariantIndex in interface CBSerializationContextOutputType

Parameters:

x - The index

writeS64

public void writeS64(long x)

Description copied from interface: CBSerializationContextOutputType

Write a signed 64-bit value

Specified by:

writeS64 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeS32

public void writeS32(long x)

Description copied from interface: CBSerializationContextOutputType

Write a signed 32-bit value

Specified by:

writeS32 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeS16

public void writeS16(long x)

Description copied from interface: CBSerializationContextOutputType

Write a signed 16-bit value

Specified by:

writeS16 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeS8

public void writeS8(long x)

Description copied from interface: CBSerializationContextOutputType

Write a signed 8-bit value

Specified by:

writeS8 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeU64

public void writeU64(long x)

Description copied from interface: CBSerializationContextOutputType

Write an unsigned 64-bit value

Specified by:

writeU64 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeU32

public void writeU32(long x)

Description copied from interface: CBSerializationContextOutputType

Write an unsigned 32-bit value

Specified by:

writeU32 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeU16

public void writeU16(long x)

Description copied from interface: CBSerializationContextOutputType

Write an unsigned 16-bit value

Specified by:

writeU16 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeU8

public void writeU8(long x)

Description copied from interface: CBSerializationContextOutputType

Write an unsigned 8-bit value

Specified by:

writeU8 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeF64

public void writeF64(double x)

Description copied from interface: CBSerializationContextOutputType

Write a floating point 64-bit value

Specified by:

writeF64 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeF32

public void writeF32(double x)

Description copied from interface: CBSerializationContextOutputType

Write a floating point 32-bit value

Specified by:

writeF32 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeF16

public void writeF16(double x)

Description copied from interface: CBSerializationContextOutputType

Write a floating point 16-bit value

Specified by:

writeF16 in interface CBSerializationContextOutputType

Parameters:

x - The value

writeByteArray

public void writeByteArray(ByteBuffer x)

Description copied from interface: CBSerializationContextOutputType

Write a byte array value.

Specified by:

writeByteArray in interface CBSerializationContextOutputType

Parameters:

x - The value

writeUTF8

public void writeUTF8(String x)

Description copied from interface: CBSerializationContextOutputType

Write a UTF-8 string value.

Specified by:

writeUTF8 in interface CBSerializationContextOutputType

Parameters:

x - The value

begin

public void begin(String item)

Description copied from interface: CBSerializationContextTracingType

Begin serializing the given item.

Specified by:

begin in interface CBSerializationContextTracingType

Parameters:

item - The item

begin

public void begin(String item,
 int index)

Description copied from interface: CBSerializationContextTracingType

Begin serializing the given item at index index.

Specified by:

begin in interface CBSerializationContextTracingType

Parameters:

item - The item

index - the index

end

public void end(String item)

Description copied from interface: CBSerializationContextTracingType

Finish serializing the given item.

Specified by:

end in interface CBSerializationContextTracingType

Parameters:

item - The item

end

public void end(String item,
 int index)

Description copied from interface: CBSerializationContextTracingType

Finish serializing the given item at index index.

Specified by:

end in interface CBSerializationContextTracingType

Parameters:

item - The item

index - the index

errorUnrecognizedVariantIndex

public IOException errorUnrecognizedVariantIndex(Class<?> readerClass,
 int index)

Description copied from interface: CBSerializationContextErrorType

An unrecognized variant index was encountered.

Specified by:

errorUnrecognizedVariantIndex in interface CBSerializationContextErrorType

Parameters:

readerClass - The class attempting the read

index - The index

Returns:

An exception detailing the errors

errorUnrecognizedVariantCaseClass

public IOException errorUnrecognizedVariantCaseClass(Class<?> writerClass,
 Class<?> clazz)

Description copied from interface: CBSerializationContextErrorType

An unrecognized variant case class was encountered.

Specified by:

errorUnrecognizedVariantCaseClass in interface CBSerializationContextErrorType

Parameters:

writerClass - The class attempting the write

clazz - The class

Returns:

An exception detailing the errors