Top Description Methods
io.netty.handler.codec.http.multipart

public Interface FileUpload

extends HttpData
Known Direct Implementers
io.netty.handler.codec.http.multipart.MemoryFileUpload, io.netty.handler.codec.http.multipart.MixedFileUpload, io.netty.handler.codec.http.multipart.DiskFileUpload
Imports
io.netty.buffer.ByteBuf
FileUpload interface that could be in memory, on temporary file or any other implementations. Most methods are inspired from java.io.File API.

Method Summary

Modifier and TypeMethod and Description
public FileUpload
copy()

Redeclares io.netty.handler.codec.http.multipart.HttpData.copy.

Creates a deep copy of this ByteBufHolder.
public FileUpload
duplicate()

Redeclares io.netty.handler.codec.http.multipart.HttpData.duplicate.

Duplicates this ByteBufHolder.
public String

Returns:

the Content-Transfer-Encoding
getContentTransferEncoding()

Returns the Content-Transfer-Encoding

public String

Returns:

the content type passed by the browser or null if not defined.
getContentType()

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

public String

Returns:

the original filename
getFilename()

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

public FileUpload
replace(ByteBuf content)

Redeclares io.netty.handler.codec.http.multipart.HttpData.replace.

Returns a new ByteBufHolder which contains the specified content.
public FileUpload
retain()

Redeclares io.netty.handler.codec.http.multipart.HttpData.retain.

Increases the reference count by 1.
public FileUpload
retain(int increment)

Redeclares io.netty.handler.codec.http.multipart.HttpData.retain.

Increases the reference count by the specified increment.
public FileUpload
retainedDuplicate()

Redeclares io.netty.handler.codec.http.multipart.HttpData.retainedDuplicate.

Duplicates this ByteBufHolder.
public void
setContentTransferEncoding(String contentTransferEncoding)

Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary

public void
setContentType(String
Content Type to set - must be not null
contentType)

Set the Content Type passed by the browser if defined

public void
setFilename(String filename)

Set the original filename

public FileUpload
touch()

Redeclares io.netty.handler.codec.http.multipart.HttpData.touch.

Records the current access location of this object for debugging purposes.
public FileUpload
touch(Object hint)

Redeclares io.netty.handler.codec.http.multipart.HttpData.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
Inherited from io.netty.handler.codec.http.multipart.HttpData:
addContentcheckSizedefinedLengthdeletegetgetByteBufgetCharsetgetChunkgetFilegetMaxSizegetStringgetStringisCompletedisInMemorylengthrenameTosetCharsetsetContentsetContentsetContentsetMaxSize

Method Detail

copyback to summary
public FileUpload copy()

Redeclares io.netty.handler.codec.http.multipart.HttpData.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations
@Override
duplicateback to summary
public FileUpload duplicate()

Redeclares io.netty.handler.codec.http.multipart.HttpData.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

Duplicates this ByteBufHolder. Be aware that this will not automatically call retain().

Annotations
@Override
getContentTransferEncodingback to summary
public String getContentTransferEncoding()

Returns the Content-Transfer-Encoding

Returns:String

the Content-Transfer-Encoding

getContentTypeback to summary
public String getContentType()

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

Returns:String

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

getFilenameback to summary
public String getFilename()

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

Returns:String

the original filename

replaceback to summary
public FileUpload replace(ByteBuf content)

Redeclares io.netty.handler.codec.http.multipart.HttpData.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations
@Override
retainback to summary
public FileUpload retain()

Redeclares io.netty.handler.codec.http.multipart.HttpData.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public FileUpload retain(int increment)

Redeclares io.netty.handler.codec.http.multipart.HttpData.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public FileUpload retainedDuplicate()

Redeclares io.netty.handler.codec.http.multipart.HttpData.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike duplicate().

Annotations
@Override
setContentTransferEncodingback to summary
public void setContentTransferEncoding(String contentTransferEncoding)

Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary

setContentTypeback to summary
public void setContentType(String contentType)

Set the Content Type passed by the browser if defined

Parameters
contentType:String

Content Type to set - must be not null

setFilenameback to summary
public void setFilename(String filename)

Set the original filename

touchback to summary
public FileUpload touch()

Redeclares io.netty.handler.codec.http.multipart.HttpData.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Annotations
@Override
touchback to summary
public FileUpload touch(Object hint)

Redeclares io.netty.handler.codec.http.multipart.HttpData.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Annotations
@Override