com.pcloud.networking.protocol

Class BytesWriter

java.lang.Object

com.pcloud.networking.protocol.BytesWriter

All Implemented Interfaces:

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

public class BytesWriter
extends java.lang.Object
implements ProtocolRequestWriter

Writes bytes into a sink

An implementation of a ProtocolRequestWriter which is able to write bytes into a BufferedSink

Generally used to write a network request

See Also:

ProtocolWriter, ProtocolRequestWriter, BufferedSink

Constructor Summary

Constructors

Constructor and Description
BytesWriter(okio.BufferedSink sink) Create a BytesReader instance

Method Summary

Modifier and Type	Method and Description
ProtocolRequestWriter	beginRequest() Start a request
void	close() Close the BufferedSink
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 class java.lang.Object

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

Constructor Detail

BytesWriter

public BytesWriter(okio.BufferedSink sink)

Create a BytesReader instance

Parameters:

sink - a BufferedSink to house the bytes

Throws:

java.lang.IllegalArgumentException - on a null BufferedSink argument

Method Detail

beginRequest

public ProtocolRequestWriter beginRequest()
                                   throws java.io.IOException

Description copied from interface: ProtocolRequestWriter

Start a request

Specified by:

beginRequest in interface ProtocolRequestWriter

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeMethodName

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

Description copied from interface: ProtocolRequestWriter

Write the method name of the request

Specified by:

writeMethodName in interface ProtocolRequestWriter

Parameters:

name - a non-null string

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

endRequest

public ProtocolRequestWriter endRequest()
                                 throws java.io.IOException

Description copied from interface: ProtocolRequestWriter

Finish a request

Specified by:

endRequest in interface ProtocolRequestWriter

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeData

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

Description copied from interface: ProtocolRequestWriter

Set a DataSource as request data

Specified by:

writeData in interface ProtocolRequestWriter

Parameters:

source - a non-null DataSource object

Returns:

a reference to this object

Throws:

java.io.IOException - on a failed IO operation

writeName

public 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 ProtocolRequestWriter

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

public 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 ProtocolRequestWriter

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

public 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 ProtocolRequestWriter

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

public 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 ProtocolRequestWriter

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

public 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 ProtocolRequestWriter

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

writeValue

public 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 ProtocolRequestWriter

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

public 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 ProtocolRequestWriter

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

close

public void close()

Close the BufferedSink

Specified by:

close in interface ProtocolWriter

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable