org.jboss.netty.handler.codec.http.multipart

接口 HttpData

所有超级接口:

java.lang.Comparable<InterfaceHttpData>, InterfaceHttpData

所有已知子接口:

Attribute, FileUpload

所有已知实现类:

AbstractDiskHttpData, AbstractHttpData, AbstractMemoryHttpData, DiskAttribute, DiskFileUpload, MemoryAttribute, MemoryFileUpload, MixedAttribute, MixedFileUpload

public interface HttpData
extends InterfaceHttpData

Extended interface for InterfaceHttpData

嵌套类概要

从接口继承的嵌套类/接口 org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData

InterfaceHttpData.HttpDataType

方法概要

方法

限定符和类型	方法和说明
void	addContent(ChannelBuffer buffer, boolean last) Add the content from the ChannelBuffer
void	checkSize(long newSize) Check if the new size is not reaching the max limit allowed.
void	delete() 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.
ChannelBuffer	getChannelBuffer() Returns the content of the file item as a ChannelBuffer
java.nio.charset.Charset	getCharset() Returns the Charset passed by the browser or null if not defined.
ChannelBuffer	getChunk(int length) Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.
java.io.File	getFile()
java.lang.String	getString() Returns the contents of the file item as a String, using the default character encoding.
java.lang.String	getString(java.nio.charset.Charset encoding) Returns the contents of the file item as a String, using the specified charset.
boolean	isCompleted()
boolean	isInMemory() Provides a hint as to whether or not the file contents will be read from memory.
long	length() Returns the size in byte of the InterfaceHttpData
boolean	renameTo(java.io.File dest) A convenience method to write an uploaded item to disk.
void	setCharset(java.nio.charset.Charset charset) Set the Charset passed by the browser if defined
void	setContent(ChannelBuffer buffer) Set the content from the ChannelBuffer (erase any previous data)
void	setContent(java.io.File file) Set the content from the file (erase any previous data)
void	setContent(java.io.InputStream inputStream) Set the content from the inputStream (erase any previous data)
void	setMaxSize(long maxSize) Set the maxSize for this HttpData.

从接口继承的方法 org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData

getHttpDataType, getName

从接口继承的方法 java.lang.Comparable

compareTo

方法详细资料

setMaxSize

void setMaxSize(long maxSize)

Set the maxSize for this HttpData. When limit will be reached, an exception will be raised. Setting it to (-1) means no limitation. By default, to be set from the HttpDataFactory.

参数:

maxSize -

checkSize

void checkSize(long newSize)
               throws java.io.IOException

Check if the new size is not reaching the max limit allowed. The limit is always computed in term of bytes.

参数:

newSize -

抛出:

java.io.IOException

setContent

void setContent(ChannelBuffer buffer)
                throws java.io.IOException

Set the content from the ChannelBuffer (erase any previous data)

参数:

buffer - must be not null

抛出:

java.io.IOException

addContent

void addContent(ChannelBuffer buffer,
              boolean last)
                throws java.io.IOException

Add the content from the ChannelBuffer

参数:

buffer - must be not null except if last is set to False

last - True of the buffer is the last one

抛出:

java.io.IOException

setContent

void setContent(java.io.File file)
                throws java.io.IOException

Set the content from the file (erase any previous data)

参数:

file - must be not null

抛出:

java.io.IOException

setContent

void setContent(java.io.InputStream inputStream)
                throws java.io.IOException

Set the content from the inputStream (erase any previous data)

参数:

inputStream - must be not null

抛出:

java.io.IOException

isCompleted

boolean isCompleted()

返回:

True if the InterfaceHttpData is completed (all data are stored)

length

long length()

Returns the size in byte of the InterfaceHttpData

返回:

the size of the InterfaceHttpData

delete

void delete()

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

get

byte[] get()
           throws java.io.IOException

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

返回:

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

抛出:

java.io.IOException

getChannelBuffer

ChannelBuffer getChannelBuffer()
                               throws java.io.IOException

Returns the content of the file item as a ChannelBuffer

返回:

the content of the file item as a ChannelBuffer

抛出:

java.io.IOException

getChunk

ChannelBuffer getChunk(int length)
                       throws java.io.IOException

Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read. Once it arrives at the end, it returns an EMPTY_BUFFER and it resets the current position to 0.

返回:

a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return

抛出:

java.io.IOException

getString

java.lang.String getString()
                           throws java.io.IOException

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

返回:

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

抛出:

java.io.IOException

getString

java.lang.String getString(java.nio.charset.Charset encoding)
                           throws java.io.IOException

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

参数:

encoding - the charset to use

返回:

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

抛出:

java.io.IOException

setCharset

void setCharset(java.nio.charset.Charset charset)

Set the Charset passed by the browser if defined

参数:

charset - Charset to set - must be not null

getCharset

java.nio.charset.Charset getCharset()

Returns the Charset passed by the browser or null if not defined.

返回:

the Charset passed by the browser or null if not defined.

renameTo

boolean renameTo(java.io.File dest)
                 throws java.io.IOException

A convenience method to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this method is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.

参数:

dest - destination file - must be not null

返回:

True if the write is successful

抛出:

java.io.IOException

isInMemory

boolean isInMemory()

Provides a hint as to whether or not the file contents will be read from memory.

返回:

True if the file contents is in memory.

getFile

java.io.File getFile()
                     throws java.io.IOException

返回:

the associated File if this data is represented in a file

抛出:

java.io.IOException - if this data is not represented by a file