dk.brics.jwig

Class FileField

java.lang.Object

dk.brics.jwig.FormField

dk.brics.jwig.FileField

public class FileField
extends FormField

File upload form field.

Constructor Summary

Constructors

Constructor and Description
FileField(FileItem f) Constructs a new file upload field.

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
byte[]	getBytes() Returns the contents of the file item as an array of bytes.
String	getContentType() Returns the content type passed by the browser or null if not defined.
String	getFileName() Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
InputStream	getInputStream() Returns an InputStream that can be used to retrieve the contents of the file.
String	getName() Returns the original filename in the client's filesystem.
long	getSize() Returns the size of the file item.
String	getString() Returns the contents of the file item as a String, using the system default encoding.
String	getString(String encoding) Returns the contents of the file item as a String, using the specified encoding.
String	getValue() Returns the contents of the file item as a String, using the system default encoding.
void	write(File file) A convenience method to write an uploaded item to disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileField

public FileField(FileItem f)

Constructs a new file upload field.

Method Detail

delete

public void delete()

Deletes the underlying storage for a file item, including deleting any associated temporary disk file.

getBytes

public byte[] getBytes()

Returns the contents of the file item as an array of bytes. This will load the entire file to the memory.

getContentType

public String getContentType()

Returns the content type passed by the browser or null if not defined.

getFileName

public String getFileName()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). This returns the filename or the full filename depending on the client's browser.

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an InputStream that can be used to retrieve the contents of the file.

Throws:

IOException

getName

public String getName()

Returns the original filename in the client's filesystem. If the browser chooses to send the whole path of the file, the string is normalized to only supply the actual filename. This returns the same string no matter what browser the client uses.

getSize

public long getSize()

Returns the size of the file item.

getString

public String getString()

Returns the contents of the file item as a String, using the system default encoding.

getString

public String getString(String encoding)
                 throws UnsupportedEncodingException

Returns the contents of the file item as a String, using the specified encoding.

Throws:

UnsupportedEncodingException

getValue

public String getValue()

Returns the contents of the file item as a String, using the system default encoding.

Specified by:

getValue in class FormField

write

public void write(File file)
           throws Exception

A convenience method to write an uploaded item to disk.

Throws:

Exception