com.pcloud.networking.protocol

Class DataSource

java.lang.Object

com.pcloud.networking.protocol.DataSource

public abstract class DataSource
extends java.lang.Object

A source of data.

An abstraction over the byte stream writing operations, this class allows for a flexible way to write bytes to a BufferedSink.

Generally used for specifying a data source when creating/uploading files.

• The create(File) method can be used for reading data from a local file.
• The create(byte[]) method can be used for reading data from a byte array.
• The create(ByteString) method can be used for reading data from Okio's immutable byte arrays.
• For any other cases just extend the class and do your magic in the writeTo(BufferedSink) method.

Field Summary

Fields

Modifier and Type	Field and Description
static DataSource	EMPTY An empty DataSource instance.

Constructor Summary

Constructors

Constructor and Description
DataSource()

Method Summary

Modifier and Type	Method and Description
long	contentLength() Provide the data source length.
static DataSource	create(byte[] data) Create a DataSource instance that reads from a byte array.
static DataSource	create(okio.ByteString data) Create a DataSource instance that reads from a ByteString.
static DataSource	create(java.io.File file) Create a DataSource instance that reads from a byte array.
abstract void	writeTo(okio.BufferedSink sink) Write the data to a BufferedSink.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final DataSource EMPTY

An empty DataSource instance.

Can be used for creating empty files.

Constructor Detail

DataSource

public DataSource()

Method Detail

contentLength

public long contentLength()

Provide the data source length.

Override this method to provide the size of the data to be written, if known in advance, otherwise return -1.

Returns:

a long representing the data source length

writeTo

public abstract void writeTo(okio.BufferedSink sink)
                      throws java.io.IOException

Write the data to a BufferedSink.

Parameters:

sink - BufferedSink

Throws:

java.io.IOException - on failed IO operations

create

public static DataSource create(okio.ByteString data)

Create a DataSource instance that reads from a ByteString.

Parameters:

data - a byte array. Must not be null.

Returns:

a DataSource that will read the given byte array.

Throws:

java.lang.IllegalArgumentException - on a null data argument.

create

public static DataSource create(byte[] data)

Create a DataSource instance that reads from a byte array.

Parameters:

data - a byte array. Must not be null.

Returns:

a DataSource that will read the given byte array.

Throws:

java.lang.IllegalArgumentException - on a null data argument.

create

public static DataSource create(java.io.File file)

Create a DataSource instance that reads from a byte array.

Parameters:

file - a file which will be read. Must not be null.

Returns:

a DataSource that will read the given file.

Throws:

java.lang.IllegalArgumentException - on a null file argument.