Package cloud.metaapi.sdk.clients

Class HttpRequestOptions.FileStreamField

java.lang.Object

cloud.metaapi.sdk.clients.HttpRequestOptions.FileStreamField

Enclosing class:

HttpRequestOptions

public static class HttpRequestOptions.FileStreamField
extends Object

File field wrapper for use in form data body. It is better to use this class for file fields because it explicitly gives opportunity to set files as File or InputStream.

Constructor Summary

Constructors

Constructor	Description
FileStreamField(File file)	Constructs the file field wrapper from File object
FileStreamField(InputStream stream, String fileName)	Constructs the file field wrapper from InputStream and the file name

Method Summary

Modifier and Type	Method	Description
String	getFileName()	Returns the file name under which the file will be sent in request
InputStream	getStream()	Returns InputStream with contents of the file
void	setFile(File file)	Sets file from File object
void	setFile(InputStream stream, String fileName)	Sets file from InputStream object

Methods inherited from class java.lang.Object

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

Constructor Detail

FileStreamField

public FileStreamField(File file)
                throws FileNotFoundException

Constructs the file field wrapper from File object

Parameters:

file - file object which will be sent in request

Throws:

FileNotFoundException

FileStreamField

public FileStreamField(InputStream stream,
                       String fileName)

Constructs the file field wrapper from InputStream and the file name

Parameters:

stream - input stream with contents of the file

fileName - file name under which the file will be sent

Method Detail

setFile

public void setFile(File file)
             throws FileNotFoundException

Sets file from File object

Parameters:

file - file object which will be sent in request

Throws:

FileNotFoundException

setFile

public void setFile(InputStream stream,
                    String fileName)

Sets file from InputStream object

Parameters:

stream - input stream with contents of the file

fileName - file name under which the file will be sent

getStream

public InputStream getStream()

Returns InputStream with contents of the file

Returns:

input stream

getFileName

public String getFileName()

Returns the file name under which the file will be sent in request

Returns:

file name