io.muserver

Interface UploadedFile

public interface UploadedFile

A file uploaded by the user, for example with an <input type="file" name="name"> input field in a multipart form.

Method Summary

Modifier and Type	Method and Description
byte[]	asBytes() Gets the file contents as a byte array.
File	asFile() Gets a copy of the file.
InputStream	asStream() Gets the uploaded file as a stream.
String	asString() Returns the contents of the file as a String, decoded using UTF-8
String	contentType() Gets the media type of the file as specified by the client, for example image/jpeg
String	extension() Gets the extension of the file as it was on the client's computer.
String	filename() Gets the original name of the file on the client's computer.
void	saveTo(File dest) Saves the file to the specified destination.
long	size() Gets the size of the file.

Method Detail

asFile

File asFile()
     throws IOException

Gets a copy of the file. This has been uploaded to the server and saved locally.

Returns:

Returns a File object pointing to the uploaded file.

Throws:

IOException - If an error while saving file.

asString

String asString()
         throws IOException

Returns the contents of the file as a String, decoded using UTF-8

Returns:

The string contents of the file.

Throws:

IOException - If an error reading the file.

asBytes

byte[] asBytes()
        throws IOException

Gets the file contents as a byte array.

Returns:

The bytes in the file.

Throws:

IOException - If any error reading the bytes.

contentType

String contentType()

Gets the media type of the file as specified by the client, for example image/jpeg

Returns:

The media type of the file.

filename

String filename()

Gets the original name of the file on the client's computer. Does not include the path.

Returns:

A file name with extension

extension

String extension()

Gets the extension of the file as it was on the client's computer.

Returns:

A string such as "jpg" or an empty string if there was no extension.

saveTo

void saveTo(File dest)
     throws IOException

Saves the file to the specified destination. Parent directories will be created if they do not exist.

Parameters:

dest - The destination to save to.

Throws:

IOException - If there is an error saving the file.

size

long size()

Gets the size of the file.

Returns:

The file size.

asStream

InputStream asStream()
              throws IOException

Gets the uploaded file as a stream.

Returns:

The file stream.

Throws:

IOException - If there is an error reading the file.