MixedAttribute (Netty API Reference (4.0.24.Final))

java.lang.Object
- io.netty.handler.codec.http.multipart.MixedAttribute

All Implemented Interfaces:

ByteBufHolder, Attribute, HttpData, InterfaceHttpData, ReferenceCounted, Comparable<InterfaceHttpData>
```
public class MixedAttribute
extends Object
implements Attribute
```
Mixed implementation using both in Memory and in File with a limit of size

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData
  InterfaceHttpData.HttpDataType

Constructor Summary

Constructors
Constructor and Description
`MixedAttribute(String name, long limitSize)`
`MixedAttribute(String name, String value, long limitSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addContent(ByteBuf buffer, boolean last)` Add the content from the ChannelBuffer
`int`	`compareTo(InterfaceHttpData o)`
`ByteBuf`	`content()` Return the data which is held by this `ByteBufHolder`.
`Attribute`	`copy()` Create a deep copy of this `ByteBufHolder`.
`void`	`delete()` Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
`Attribute`	`duplicate()` Duplicate the `ByteBufHolder`.
`byte[]`	`get()` Returns the contents of the file item as an array of bytes.
`ByteBuf`	`getByteBuf()` Returns the content of the file item as a ByteBuf
`Charset`	`getCharset()` Returns the Charset passed by the browser or null if not defined.
`ByteBuf`	`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.
`File`	`getFile()`
`InterfaceHttpData.HttpDataType`	`getHttpDataType()`
`String`	`getName()` Returns the name of this InterfaceHttpData.
`String`	`getString()` Returns the contents of the file item as a String, using the default character encoding.
`String`	`getString(Charset encoding)` Returns the contents of the file item as a String, using the specified charset.
`String`	`getValue()` Returns the value of this HttpData.
`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
`int`	`refCnt()` Returns the reference count of this object.
`boolean`	`release()` Decreases the reference count by `1` and deallocates this object if the reference count reaches at `0`.
`boolean`	`release(int decrement)` Decreases the reference count by the specified `decrement` and deallocates this object if the reference count reaches at `0`.
`boolean`	`renameTo(File dest)` A convenience getMethod to write an uploaded item to disk.
`Attribute`	`retain()` Increases the reference count by `1`.
`Attribute`	`retain(int increment)` Increases the reference count by the specified `increment`.
`void`	`setCharset(Charset charset)` Set the Charset passed by the browser if defined
`void`	`setContent(ByteBuf buffer)` Set the content from the ChannelBuffer (erase any previous data)
`void`	`setContent(File file)` Set the content from the file (erase any previous data)
`void`	`setContent(InputStream inputStream)` Set the content from the inputStream (erase any previous data)
`void`	`setValue(String value)` Sets the value of this HttpData.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MixedAttribute
```
public MixedAttribute(String name,
              long limitSize)
```
  - MixedAttribute
```
public MixedAttribute(String name,
              String value,
              long limitSize)
```
- Method Detail
  - addContent
```
public void addContent(ByteBuf buffer,
              boolean last)
                throws IOException
```
    Description copied from interface: HttpData
    
    Add the content from the ChannelBuffer
    
    Specified by:
    
    addContent in interface HttpData
    
    Parameters:
    buffer - must be not null except if last is set to False
    last - True of the buffer is the last one
    
    Throws:
    
    IOException
  - delete
```
public void delete()
```
    Description copied from interface: HttpData
    
    Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
    
    Specified by:
    
    delete in interface HttpData
  - get
```
public byte[] get()
           throws IOException
```
    Description copied from interface: HttpData
    
    Returns the contents of the file item as an array of bytes.
    
    Specified by:
    
    get in interface HttpData
    
    Returns:
    the contents of the file item as an array of bytes.
    
    Throws:
    
    IOException
  - getByteBuf
```
public ByteBuf getByteBuf()
                   throws IOException
```
    Description copied from interface: HttpData
    
    Returns the content of the file item as a ByteBuf
    
    Specified by:
    
    getByteBuf in interface HttpData
    
    Returns:
    the content of the file item as a ByteBuf
    
    Throws:
    
    IOException
  - getCharset
```
public Charset getCharset()
```
    Description copied from interface: HttpData
    
    Returns the Charset passed by the browser or null if not defined.
    
    Specified by:
    
    getCharset in interface HttpData
    
    Returns:
    the Charset passed by the browser or null if not defined.
  - getString
```
public String getString()
                 throws IOException
```
    Description copied from interface: HttpData
    
    Returns the contents of the file item as a String, using the default character encoding.
    
    Specified by:
    
    getString in interface HttpData
    
    Returns:
    the contents of the file item as a String, using the default character encoding.
    
    Throws:
    
    IOException
  - getString
```
public String getString(Charset encoding)
                 throws IOException
```
    Description copied from interface: HttpData
    
    Returns the contents of the file item as a String, using the specified charset.
    
    Specified by:
    
    getString in interface HttpData
    
    Parameters:
    encoding - the charset to use
    
    Returns:
    the contents of the file item as a String, using the specified charset.
    
    Throws:
    
    IOException
  - isCompleted
```
public boolean isCompleted()
```
    Specified by:
    
    isCompleted in interface HttpData
    
    Returns:
    True if the InterfaceHttpData is completed (all data are stored)
  - isInMemory
```
public boolean isInMemory()
```
    Description copied from interface: HttpData
    
    Provides a hint as to whether or not the file contents will be read from memory.
    
    Specified by:
    
    isInMemory in interface HttpData
    
    Returns:
    True if the file contents is in memory.
  - length
```
public long length()
```
    Description copied from interface: HttpData
    
    Returns the size in byte of the InterfaceHttpData
    
    Specified by:
    
    length in interface HttpData
    
    Returns:
    the size of the InterfaceHttpData
  - renameTo
```
public boolean renameTo(File dest)
                 throws IOException
```
    Description copied from interface: HttpData
    
    A convenience getMethod to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this getMethod is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.
    
    Specified by:
    
    renameTo in interface HttpData
    
    Parameters:
    dest - destination file - must be not null
    
    Returns:
    True if the write is successful
    
    Throws:
    
    IOException
  - setCharset
```
public void setCharset(Charset charset)
```
    Description copied from interface: HttpData
    
    Set the Charset passed by the browser if defined
    
    Specified by:
    
    setCharset in interface HttpData
    
    Parameters:
    charset - Charset to set - must be not null
  - setContent
```
public void setContent(ByteBuf buffer)
                throws IOException
```
    Description copied from interface: HttpData
    
    Set the content from the ChannelBuffer (erase any previous data)
    
    Specified by:
    
    setContent in interface HttpData
    
    Parameters:
    buffer - must be not null
    
    Throws:
    
    IOException
  - setContent
```
public void setContent(File file)
                throws IOException
```
    Description copied from interface: HttpData
    
    Set the content from the file (erase any previous data)
    
    Specified by:
    
    setContent in interface HttpData
    
    Parameters:
    file - must be not null
    
    Throws:
    
    IOException
  - setContent
```
public void setContent(InputStream inputStream)
                throws IOException
```
    Description copied from interface: HttpData
    
    Set the content from the inputStream (erase any previous data)
    
    Specified by:
    
    setContent in interface HttpData
    
    Parameters:
    inputStream - must be not null
    
    Throws:
    
    IOException
  - getHttpDataType
```
public InterfaceHttpData.HttpDataType getHttpDataType()
```
    Specified by:
    
    getHttpDataType in interface InterfaceHttpData
    
    Returns:
    The HttpDataType
  - getName
```
public String getName()
```
    Description copied from interface: InterfaceHttpData
    
    Returns the name of this InterfaceHttpData.
    
    Specified by:
    
    getName in interface InterfaceHttpData
  - compareTo
```
public int compareTo(InterfaceHttpData o)
```
    Specified by:
    
    compareTo in interface Comparable<InterfaceHttpData>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValue
```
public String getValue()
                throws IOException
```
    Description copied from interface: Attribute
    
    Returns the value of this HttpData.
    
    Specified by:
    
    getValue in interface Attribute
    
    Throws:
    
    IOException
  - setValue
```
public void setValue(String value)
              throws IOException
```
    Description copied from interface: Attribute
    
    Sets the value of this HttpData.
    
    Specified by:
    
    setValue in interface Attribute
    
    Throws:
    
    IOException
  - getChunk
```
public ByteBuf getChunk(int length)
                 throws IOException
```
    Description copied from interface: HttpData
    
    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.
    
    Specified by:
    
    getChunk in interface HttpData
    
    Returns:
    a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return
    
    Throws:
    
    IOException
  - getFile
```
public File getFile()
             throws IOException
```
    Specified by:
    
    getFile in interface HttpData
    
    Returns:
    the associated File if this data is represented in a file
    
    Throws:
    
    IOException - if this data is not represented by a file
  - copy
```
public Attribute copy()
```
    Description copied from interface: ByteBufHolder
    
    Create a deep copy of this ByteBufHolder.
    
    Specified by:
    
    copy in interface ByteBufHolder
    
    Specified by:
    
    copy in interface Attribute
    
    Specified by:
    
    copy in interface HttpData
  - duplicate
```
public Attribute duplicate()
```
    Description copied from interface: ByteBufHolder
    
    Duplicate the ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().
    
    Specified by:
    
    duplicate in interface ByteBufHolder
    
    Specified by:
    
    duplicate in interface Attribute
    
    Specified by:
    
    duplicate in interface HttpData
  - content
```
public ByteBuf content()
```
    Description copied from interface: ByteBufHolder
    
    Return the data which is held by this ByteBufHolder.
    
    Specified by:
    
    content in interface ByteBufHolder
  - refCnt
```
public int refCnt()
```
    Description copied from interface: ReferenceCounted
    
    Returns the reference count of this object. If 0, it means this object has been deallocated.
    
    Specified by:
    
    refCnt in interface ReferenceCounted
  - retain
```
public Attribute retain()
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by 1.
    
    Specified by:
    
    retain in interface ByteBufHolder
    
    Specified by:
    
    retain in interface Attribute
    
    Specified by:
    
    retain in interface HttpData
    
    Specified by:
    
    retain in interface ReferenceCounted
  - retain
```
public Attribute retain(int increment)
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    Specified by:
    
    retain in interface ByteBufHolder
    
    Specified by:
    
    retain in interface Attribute
    
    Specified by:
    
    retain in interface HttpData
    
    Specified by:
    
    retain in interface ReferenceCounted
  - release
```
public boolean release()
```
    Description copied from interface: ReferenceCounted
    
    Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
    
    Specified by:
    
    release in interface ReferenceCounted
    
    Returns:
    true if and only if the reference count became 0 and this object has been deallocated
  - release
```
public boolean release(int decrement)
```
    Description copied from interface: ReferenceCounted
    
    Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
    
    Specified by:
    
    release in interface ReferenceCounted
    
    Returns:
    true if and only if the reference count became 0 and this object has been deallocated

Class MixedAttribute

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MixedAttribute

MixedAttribute

Method Detail

addContent

delete

get

getByteBuf

getCharset

getString

getString

isCompleted

isInMemory

length

renameTo

setCharset

setContent

setContent

setContent

getHttpDataType

getName

compareTo

toString

getValue

setValue

getChunk

getFile

copy

duplicate

content

refCnt

retain

retain

release

release