com.pcloud.networking.protocol

Interface ProtocolWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

ProtocolRequestWriter

All Known Implementing Classes:

BytesWriter, ForwardingProtocolRequestWriter, ForwardingProtocolWriter

public interface ProtocolWriter
extends java.lang.AutoCloseable, java.io.Closeable

A contract for a encoding parameters and their values in a type-safe manner

See Also:

BytesWriter, ValueWriter

Method Summary

Modifier and Type	Method and Description
void	close()
ProtocolWriter	writeName(java.lang.String name) Write the name of a parameter
ProtocolWriter	writeValue(boolean value) Write the value of a parameter
ProtocolWriter	writeValue(double value) Write the value of a parameter
ProtocolWriter	writeValue(float value) Write the value of a parameter
ProtocolWriter	writeValue(long value) Write the value of a parameter
ProtocolWriter	writeValue(java.lang.Object value) Write the value of a parameter
ProtocolWriter	writeValue(java.lang.String value) Write the value of a parameter

Method Detail

writeName

ProtocolWriter writeName(java.lang.String name)
                  throws java.io.IOException

Write the name of a parameter

Every call of this method should be followed by a call to one the variants of writeValue()

Parameters:

name - the non-null name of the parameter

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

java.lang.IllegalArgumentException - on a null argument

writeValue

ProtocolWriter writeValue(java.lang.Object value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

The provided argument must be a non-null object, of type String or any of the boxed variants of primitive types. An object will be accepted if Class.isPrimitive() returns true for the object type.

Parameters:

value - a non-null object

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

java.lang.IllegalArgumentException - on a null argument

java.lang.IllegalArgumentException - if the argument is of invalid type

writeValue

ProtocolWriter writeValue(java.lang.String value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

Parameters:

value - a non-null String object

Returns:

a reference to this object

Throws:

java.io.IOException - on failed IO operations

java.lang.IllegalArgumentException - on a null argument

writeValue

ProtocolWriter writeValue(double value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

Parameters:

value - a double

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

ProtocolWriter writeValue(float value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

Parameters:

value - a float

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

ProtocolWriter writeValue(long value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

Parameters:

value - a long

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

ProtocolWriter writeValue(boolean value)
                   throws java.io.IOException

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to writeName(String).

Parameters:

value - a boolean

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable