to.etc.domui.util.upload

Class UploadItem

java.lang.Object

to.etc.domui.util.upload.UploadItem

public final class UploadItem
extends Object

An item that was gotten through the multipart/form data code. This can represent an uploaded file, and all of the metadata that the browser has sent while it uploaded the file. When used from a page, the actual file data will be deleted as soon as the page is destroyed, you must make a copy if you want to retain the data.

Author:

Frits Jalvingh Created on Jan 12, 2011

Constructor Summary

Constructors

Constructor and Description
UploadItem(String fieldname, String contenttype, String charset, String filename, boolean isfile)

Method Summary

Modifier and Type	Method and Description
void	close() Called from user code to release the file attached to this item.
String	getCharSet() If known, the character set for how the data is to be decoded.
String	getContentType() If specified, the MIME content type the browser provided during the upload.
File	getFile() Return a file for this item.
String	getName() The name of the input field.
String	getRemoteFileName() If specified, the name that the browser provided as the "local file name", i.e.
int	getSize() If this is a FILE item, this contains the size, in bytes, of the uploaded file.
String	getValue() If this is a parameter and not a File, this contains the parameter's value, decoded using the browser-specified character encoding.
boolean	isEmpty() SILLY_INTERFACE? If this holds no value it returns true.
boolean	isFile() T if this actually contains a file (it is not just a parameter).
void	setFile(File f) Called when the item is resident in a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadItem

public UploadItem(String fieldname,
                  String contenttype,
                  String charset,
                  String filename,
                  boolean isfile)

Method Detail

isFile

public boolean isFile()

T if this actually contains a file (it is not just a parameter).

Returns:

setFile

public void setFile(File f)

Called when the item is resident in a file. When called the code takes ownership of the file, and deletes the file as soon as this item gets finalized or otherwise cleaned up.

Parameters:

f -

getCharSet

@Nullable
public String getCharSet()

If known, the character set for how the data is to be decoded. Can be null.

getValue

public String getValue()

If this is a parameter and not a File, this contains the parameter's value, decoded using the browser-specified character encoding.

getName

@Nonnull
public String getName()

The name of the input field.

Returns:

getRemoteFileName

@Nullable
public String getRemoteFileName()

If specified, the name that the browser provided as the "local file name", i.e. the name of the file on the browser's file system that was selected for upload. Will not usually contain a path.

Returns:

getContentType

@Nullable
public String getContentType()

If specified, the MIME content type the browser provided during the upload.

Returns:

getSize

public int getSize()

If this is a FILE item, this contains the size, in bytes, of the uploaded file.

Returns:

isEmpty

public boolean isEmpty()

SILLY_INTERFACE? If this holds no value it returns true.

Returns:

getFile

public File getFile()

Return a file for this item. If the item is not yet file-based then a new file is generated for this item.

See Also:

to.etc.server.upload.UploadItem#getFile()

close

public void close()

Called from user code to release the file attached to this item.