net.hasor.web

接口 FileItem

所有超级接口:

FileItemStream

所有已知实现类:

DiskFileItem, DiskFileItemFactory.MemoryFileItem, FileItemBase

public interface FileItem
extends FileItemStream

This class represents a file or form item that was received within a multipart/form-data POST request.

从以下版本开始:

1.3 additionally implements FileItemHeadersSupport

版本:

$Id: FileItem.java 1454690 2013-03-09 12:08:48Z simonetripodi $

方法概要

限定符和类型	方法和说明
void	deleteOrSkip() Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
byte[]	get() Returns the contents of the file item as an array of bytes.
long	getSize() Returns the size of the file item.
String	getString() Returns the contents of the file item as a String, using the default character encoding.
String	getString(String encoding) Returns the contents of the file item as a String, using the specified encoding.
void	writeTo(File file) A convenience method to write an uploaded item to disk.
void	writeTo(OutputStream outStream) A convenience method to write an uploaded item to disk.

从接口继承的方法 net.hasor.web.FileItemStream

getContentType, getFieldName, getHeaders, getName, isFormField, openStream

方法详细资料

getSize

long getSize()

Returns the size of the file item.

返回:

The size of the file item, in bytes.

writeTo

void writeTo(File file)
      throws IOException

A convenience method to write an uploaded item to disk. The client code is not concerned with whether or not the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item to a file.

This method is not guaranteed to succeed if called more than once for the same item. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.

参数:

file - The File into which the uploaded item should be stored.

抛出:

Exception - if an error occurs.

IOException

writeTo

void writeTo(OutputStream outStream)
      throws IOException

A convenience method to write an uploaded item to disk. The client code is not concerned with whether or not the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item to a file.

This method is not guaranteed to succeed if called more than once for the same item. This allows a particular implementation to use, for example, file renaming, where possible, rather than copying all of the underlying data, thus gaining a significant performance benefit.

参数:

outStream - The OutputStream into which the uploaded item should be stored.

抛出:

Exception - if an error occurs.

IOException

deleteOrSkip

void deleteOrSkip()

Deletes the underlying storage for a file item, including deleting any associated temporary disk file. Although this storage will be deleted automatically when the FileItem instance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.

get

byte[] get()
    throws IOException

Returns the contents of the file item as an array of bytes.

返回:

The contents of the file item as an array of bytes.

抛出:

IOException

getString

String getString(String encoding)
          throws IOException

Returns the contents of the file item as a String, using the specified encoding. This method uses get() to retrieve the contents of the item.

参数:

encoding - The character encoding to use.

返回:

The contents of the item, as a string.

抛出:

UnsupportedEncodingException - if the requested character encoding is not available.

IOException

getString

String getString()
          throws IOException

Returns the contents of the file item as a String, using the default character encoding. This method uses get() to retrieve the contents of the item.

返回:

The contents of the item, as a string.

抛出:

IOException