bayou.form

Class FormDataFile

java.lang.Object

bayou.form.FormDataFile

public class FormDataFile
extends Object

A file in a form data set.

Constructor Summary

Constructors

Constructor and Description
FormDataFile(String fileName, ContentType contentType, Path localPath, long size) Create a FormDataFile.

Method Summary

Instance Methods
String	fileName() The name of the file, as reported by the client.
ContentType	contentType() The content type of the file, as reported by the client.
Path	localPath() Where the file is stored on the local file system.
long	size() The size of the file.
String	toString() A string representing this object, for diagnosis purpose.
void	delete() Delete the local file identified by localPath.
Static Method
FormDataFile	of(String localPath) Create a FormDataFile based on the local file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormDataFile

public FormDataFile(String fileName,
                    ContentType contentType,
                    Path localPath,
                    long size)

Create a FormDataFile.

Method Detail

of

public static FormDataFile of(String localPath)

Create a FormDataFile based on the local file.

The ContentType is looked up from FileSuffixToContentType.getGlobalInstance().

CAUTION: this method reads file metadata from OS, which may involve blocking IO operations.

Throws:

RuntimeException - if the file does not exist

fileName

public String fileName()

The name of the file, as reported by the client.

The file name may contain chars that are invalid on the server's file system.

contentType

public ContentType contentType()

The content type of the file, as reported by the client.

This method may return null.

localPath

public Path localPath()

Where the file is stored on the local file system.

FormParser will store the file on local file system, and this path identifies where it is stored.

This path does not necessarily contain fileName().

size

public long size()

The size of the file.

toString

public String toString()

A string representing this object, for diagnosis purpose.

Overrides:

toString in class Object

delete

public void delete()

Delete the local file identified by localPath.

This method is non-blocking; errors will be silently logged.