DefaultHttp2DataFrame (Netty API Reference (4.1.0.CR7))

java.lang.Object
- io.netty.handler.codec.http2.AbstractHttp2StreamFrame
- - io.netty.handler.codec.http2.DefaultHttp2DataFrame

All Implemented Interfaces:

ByteBufHolder, Http2DataFrame, Http2Frame, Http2StreamFrame, ReferenceCounted
```
public final class DefaultHttp2DataFrame
extends AbstractHttp2StreamFrame
implements Http2DataFrame
```
The default Http2DataFrame implementation.

Constructor Summary

Constructors
Constructor and Description
`DefaultHttp2DataFrame(boolean endStream)` Equivalent to `new DefaultHttp2DataFrame(Unpooled.EMPTY_BUFFER, endStream)`.
`DefaultHttp2DataFrame(ByteBuf content)` Equivalent to `new DefaultHttp2DataFrame(content, false)`.
`DefaultHttp2DataFrame(ByteBuf content, boolean endStream)` Equivalent to `new DefaultHttp2DataFrame(content, endStream, 0)`.
`DefaultHttp2DataFrame(ByteBuf content, boolean endStream, int padding)` Construct a new data message.

Method Summary

Methods
Modifier and Type	Method and Description
`ByteBuf`	`content()` Payload of DATA frame.
`DefaultHttp2DataFrame`	`copy()` Create a deep copy of this `ByteBufHolder`.
`DefaultHttp2DataFrame`	`duplicate()` Duplicate the `ByteBufHolder`.
`boolean`	`equals(Object o)` Returns `true` if `o` has equal `stream` to this object.
`int`	`hashCode()`
`boolean`	`isEndStream()` `true` if this frame is the last one in this direction of the stream.
`int`	`padding()` Frame padding to use.
`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`.
`DefaultHttp2DataFrame`	`retain()` Increases the reference count by `1`.
`DefaultHttp2DataFrame`	`retain(int increment)` Increases the reference count by the specified `increment`.
`DefaultHttp2DataFrame`	`setStream(Object stream)` Set the stream identifier for this message.
`String`	`toString()`
`DefaultHttp2DataFrame`	`touch()` Records the current access location of this object for debugging purposes.
`DefaultHttp2DataFrame`	`touch(Object hint)` Records the current access location of this object with an additonal arbitrary information for debugging purposes.

Methods inherited from class io.netty.handler.codec.http2.AbstractHttp2StreamFrame
stream

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

Methods inherited from interface io.netty.handler.codec.http2.Http2StreamFrame
stream

- Constructor Detail
  - DefaultHttp2DataFrame
```
public DefaultHttp2DataFrame(ByteBuf content)
```
    Equivalent to new DefaultHttp2DataFrame(content, false).
    
    Parameters:
    content - non-null payload
  - DefaultHttp2DataFrame
```
public DefaultHttp2DataFrame(boolean endStream)
```
    Equivalent to new DefaultHttp2DataFrame(Unpooled.EMPTY_BUFFER, endStream).
    
    Parameters:
    endStream - whether this data should terminate the stream
  - DefaultHttp2DataFrame
```
public DefaultHttp2DataFrame(ByteBuf content,
                     boolean endStream)
```
    Equivalent to new DefaultHttp2DataFrame(content, endStream, 0).
    
    Parameters:
    content - non-null payload
    endStream - whether this data should terminate the stream
  - DefaultHttp2DataFrame
```
public DefaultHttp2DataFrame(ByteBuf content,
                     boolean endStream,
                     int padding)
```
    Construct a new data message.
    
    Parameters:
    content - non-null payload
    endStream - whether this data should terminate the stream
    padding - additional bytes that should be added to obscure the true content size
- Method Detail
  - setStream
```
public DefaultHttp2DataFrame setStream(Object stream)
```
    Description copied from interface: Http2StreamFrame
    
    Set the stream identifier for this message.
    
    Specified by:
    
    setStream in interface Http2DataFrame
    
    Specified by:
    
    setStream in interface Http2StreamFrame
    
    Overrides:
    
    setStream in class AbstractHttp2StreamFrame
    
    Returns:
    this
  - isEndStream
```
public boolean isEndStream()
```
    Description copied from interface: Http2DataFrame
    
    true if this frame is the last one in this direction of the stream.
    
    Specified by:
    
    isEndStream in interface Http2DataFrame
  - padding
```
public int padding()
```
    Description copied from interface: Http2DataFrame
    
    Frame padding to use. Will be non-negative and less than 256.
    
    Specified by:
    
    padding in interface Http2DataFrame
  - content
```
public ByteBuf content()
```
    Description copied from interface: Http2DataFrame
    
    Payload of DATA frame. Will not be null.
    
    Specified by:
    
    content in interface ByteBufHolder
    
    Specified by:
    
    content in interface Http2DataFrame
  - copy
```
public DefaultHttp2DataFrame copy()
```
    Description copied from interface: ByteBufHolder
    
    Create a deep copy of this ByteBufHolder.
    
    Specified by:
    
    copy in interface ByteBufHolder
    
    Specified by:
    
    copy in interface Http2DataFrame
  - duplicate
```
public DefaultHttp2DataFrame 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 Http2DataFrame
  - 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
  - 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
  - retain
```
public DefaultHttp2DataFrame retain()
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by 1.
    
    Specified by:
    
    retain in interface ByteBufHolder
    
    Specified by:
    
    retain in interface Http2DataFrame
    
    Specified by:
    
    retain in interface ReferenceCounted
  - retain
```
public DefaultHttp2DataFrame 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 Http2DataFrame
    
    Specified by:
    
    retain in interface ReferenceCounted
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - touch
```
public DefaultHttp2DataFrame touch()
```
    Description copied from interface: ReferenceCounted
    
    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).
    
    Specified by:
    
    touch in interface ByteBufHolder
    
    Specified by:
    
    touch in interface Http2DataFrame
    
    Specified by:
    
    touch in interface ReferenceCounted
  - touch
```
public DefaultHttp2DataFrame touch(Object hint)
```
    Description copied from interface: ReferenceCounted
    
    Records the current access location of this object with an additonal 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.
    
    Specified by:
    
    touch in interface ByteBufHolder
    
    Specified by:
    
    touch in interface Http2DataFrame
    
    Specified by:
    
    touch in interface ReferenceCounted
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: AbstractHttp2StreamFrame
    
    Returns true if o has equal stream to this object.
    
    Overrides:
    
    equals in class AbstractHttp2StreamFrame
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractHttp2StreamFrame

Class DefaultHttp2DataFrame

Constructor Summary

Method Summary

Methods inherited from class io.netty.handler.codec.http2.AbstractHttp2StreamFrame

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.handler.codec.http2.Http2StreamFrame

Constructor Detail

DefaultHttp2DataFrame

DefaultHttp2DataFrame

DefaultHttp2DataFrame

DefaultHttp2DataFrame

Method Detail

setStream

isEndStream

padding

content

copy

duplicate

refCnt

release

release

retain

retain

toString

touch

touch

equals

hashCode