com.pcloud.networking.protocol

Interface ProtocolRequestWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ProtocolWriter

All Known Implementing Classes:

BytesWriter, ForwardingProtocolRequestWriter

public interface ProtocolRequestWriter
extends ProtocolWriter

A contract for serializing requests

See Also:

BytesWriter

Method Summary

Modifier and Type	Method and Description
ProtocolRequestWriter	beginRequest() Start a request
ProtocolRequestWriter	endRequest() Finish a request
ProtocolRequestWriter	writeData(DataSource source) Set a DataSource as request data
ProtocolRequestWriter	writeMethodName(java.lang.String name) Write the method name of the request
ProtocolRequestWriter	writeName(java.lang.String name) Write the name of a parameter
ProtocolRequestWriter	writeValue(boolean value) Write the value of a parameter
ProtocolRequestWriter	writeValue(double value) Write the value of a parameter
ProtocolRequestWriter	writeValue(float value) Write the value of a parameter
ProtocolRequestWriter	writeValue(long value) Write the value of a parameter
ProtocolRequestWriter	writeValue(java.lang.Object value) Write the value of a parameter
ProtocolRequestWriter	writeValue(java.lang.String value) Write the value of a parameter

Methods inherited from interface com.pcloud.networking.protocol.ProtocolWriter

close

Method Detail

beginRequest

ProtocolRequestWriter beginRequest()
                            throws java.io.IOException

Start a request

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeData

ProtocolRequestWriter writeData(DataSource source)
                         throws java.io.IOException

Set a DataSource as request data

Parameters:

source - a non-null DataSource object

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

java.lang.IllegalArgumentException - on a null argument

writeMethodName

ProtocolRequestWriter writeMethodName(java.lang.String name)
                               throws java.io.IOException

Write the method name of the request

Parameters:

name - a non-null string

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

java.lang.IllegalArgumentException - on a null argument

writeName

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

Description copied from interface: ProtocolWriter

Write the name of a parameter

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

Specified by:

writeName in interface ProtocolWriter

Parameters:

name - the non-null name of the parameter

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

Every call to this or the other variants of writeValue() should be preceded by a call to ProtocolWriter.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.

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a non-null object

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

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

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a non-null String object

Returns:

a reference to this object

Throws:

java.io.IOException - on failed IO operations

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

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

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a double

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

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

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a float

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

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

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a long

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeValue

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

Description copied from interface: ProtocolWriter

Write the value of a parameter

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

Specified by:

writeValue in interface ProtocolWriter

Parameters:

value - a boolean

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

endRequest

ProtocolRequestWriter endRequest()
                          throws java.io.IOException

Finish a request

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation