com.cryptshare.api

Class TransferFile

java.lang.Object

com.cryptshare.api.TransferFile

public class TransferFile
extends java.lang.Object

Class that represents a file that is to be included in the transfer. The file can be either specified as Path or as InputStream.

Constructor Summary

Constructors

Constructor and Description
TransferFile(java.nio.file.Path filePath) Creates a new TransferFile object with the given file path, representing an actual file on the file system.
TransferFile(java.lang.String fileName, java.io.InputStream fileInputStream, long size) Creates a new TransferFile object with the given file name, input stream and file size.

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getFileInputStream() Returns the InputStream to get the file, if specified.
long	getFileInputStreamLength() Returns the specified size of the file, defined by the InputStream, see getFileInputStream()
java.lang.String	getFileName() Returns the name of the file.
java.nio.file.Path	getFilePath() Returns the file path, if specified.
java.lang.String	getId() Returns the unique ID for this transfer file.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferFile

public TransferFile(java.nio.file.Path filePath)

Creates a new TransferFile object with the given file path, representing an actual file on the file system.

Parameters:

filePath - The path to the file on the file system.

TransferFile

public TransferFile(java.lang.String fileName,
                    java.io.InputStream fileInputStream,
                    long size)

Creates a new TransferFile object with the given file name, input stream and file size. The file size is required to calculate the total transfer size.

Parameters:

fileName - The name of the streamed file.

fileInputStream - The input stream containing the data to be transferred. The input stream will be automatically closed when the data has been uploaded to the server.

size - The length of the input stream in bytes.

Throws:

java.lang.IllegalArgumentException - If the stream size is less than 0.

Method Detail

getFilePath

public java.nio.file.Path getFilePath()

Returns the file path, if specified.

Returns:

The file path or null, if the TransferFile has been constructed using an InputStream instead.

getFileName

public java.lang.String getFileName()

Returns the name of the file.

Returns:

The file name.

getFileInputStream

public java.io.InputStream getFileInputStream()

Returns the InputStream to get the file, if specified.

Returns:

The InputStream or null, if the TransferFile has been constructed using an Path instead.

getFileInputStreamLength

public long getFileInputStreamLength()

Returns the specified size of the file, defined by the InputStream, see getFileInputStream()

Returns:

The length of the stream, if specified, otherwise 0.

getId

public java.lang.String getId()

Returns the unique ID for this transfer file.

Returns:

The transfer file ID.