com.atlassian.plugins.rest.common.multipart

Interface FilePart

All Known Implementing Classes:

CommonsFileUploadFilePart

public interface FilePart

A part of a multi part request

Method Summary

Modifier and Type	Method and Description
String	getContentType() Get the content type of the part
InputStream	getInputStream() Get the input stream of the part
String	getName() Get the file name of the part
long	getSize() Retrieve the size of this FilePart, in bytes
String	getValue() Get the simple value of the part
boolean	isFormField() Whether the part is a simple form field
void	write(File file) Write the part to the given file

Method Detail

getName

String getName()

Get the file name of the part

Returns:

The file name of the part

getContentType

String getContentType()

Get the content type of the part

Returns:

The content type of the part

Since:

2.4

write

void write(File file)
    throws IOException

Write the part to the given file

Parameters:

file - The file to write the part to

Throws:

IOException

Since:

2.4

getInputStream

InputStream getInputStream()
                    throws IOException

Get the input stream of the part

Returns:

The input stream

Throws:

IOException - If an error occured

getValue

String getValue()

Get the simple value of the part

Returns:

The value

Since:

2.4

isFormField

boolean isFormField()

Whether the part is a simple form field

Returns:

True if it's a simple form field

Since:

2.4

getSize

long getSize()

Retrieve the size of this FilePart, in bytes

Since:

3.0.15