AbstractMessageBuf (Netty API Reference (4.0.0.Beta3))

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<T>
  - - io.netty.buffer.AbstractMessageBuf<T>

Type Parameters:
T -

All Implemented Interfaces:

Buf, MessageBuf<T>, ReferenceCounted, Iterable<T>, Collection<T>, Queue<T>
```
public abstract class AbstractMessageBuf<T>
extends AbstractQueue<T>
implements MessageBuf<T>
```
Abstract base class for MessageBuf implementations.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractMessageBuf(int maxCapacity)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractMessageBuf(int maxCapacity)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(T t)`
`protected abstract void`	`deallocate()`
`int`	`drainTo(Collection<? super T> c)` Drain the content of te `MessageBuf` to the given `Collection`.
`int`	`drainTo(Collection<? super T> c, int maxElements)` Drain the content of te `MessageBuf` to the given `Collection`.
`T`	`element()`
`protected void`	`ensureAccessible()`
`boolean`	`isReadable()` Returns `true` if and only if this buffer contains at least one readable element.
`boolean`	`isReadable(int size)` Returns `true` if and only if this buffer contains equal to or more than the specified number of elements.
`boolean`	`isWritable()` Returns `true` if and only if this buffer has enough room to allow writing one element.
`boolean`	`isWritable(int size)` Returns `true` if and only if this buffer has enough room to allow writing the specified number of elements.
`int`	`maxCapacity()` Returns the maximum allowed capacity of this buffer.
`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`.
`T`	`remove()`
`MessageBuf<T>`	`retain()` Increases the reference count by `1`.
`MessageBuf<T>`	`retain(int increment)` Increases the reference count by the specified `increment`.
`String`	`toString()`
`BufType`	`type()` The BufType which will be handled by the Buf implementation
`boolean`	`unfoldAndAdd(Object o)` Unfold the specified object if necessary, and then add the unfolded objects (or the specified object if unfonding was not necessary) to this buffer.

Methods inherited from class java.util.AbstractQueue
addAll, clear

Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.util.Queue
offer, peek, poll

Methods inherited from interface java.util.Collection
addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

- Constructor Detail
  - AbstractMessageBuf
```
protected AbstractMessageBuf(int maxCapacity)
```
- Method Detail
  - type
```
public final BufType type()
```
    Description copied from interface: Buf
    
    The BufType which will be handled by the Buf implementation
    
    Specified by:
    
    type in interface Buf
  - refCnt
```
public final 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 MessageBuf<T> retain()
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by 1.
    
    Specified by:
    
    retain in interface Buf
    
    Specified by:
    
    retain in interface MessageBuf<T>
    
    Specified by:
    
    retain in interface ReferenceCounted
  - retain
```
public MessageBuf<T> retain(int increment)
```
    Description copied from interface: ReferenceCounted
    
    Increases the reference count by the specified increment.
    
    Specified by:
    
    retain in interface Buf
    
    Specified by:
    
    retain in interface MessageBuf<T>
    
    Specified by:
    
    retain in interface ReferenceCounted
  - release
```
public final 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 final 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
  - deallocate
```
protected abstract void deallocate()
```
  - maxCapacity
```
public final int maxCapacity()
```
    Description copied from interface: Buf
    
    Returns the maximum allowed capacity of this buffer.
    
    Specified by:
    
    maxCapacity in interface Buf
  - isReadable
```
public final boolean isReadable()
```
    Description copied from interface: Buf
    
    Returns true if and only if this buffer contains at least one readable element.
    
    Specified by:
    
    isReadable in interface Buf
  - isReadable
```
public final boolean isReadable(int size)
```
    Description copied from interface: Buf
    
    Returns true if and only if this buffer contains equal to or more than the specified number of elements.
    
    Specified by:
    
    isReadable in interface Buf
  - isWritable
```
public final boolean isWritable()
```
    Description copied from interface: Buf
    
    Returns true if and only if this buffer has enough room to allow writing one element.
    
    Specified by:
    
    isWritable in interface Buf
  - isWritable
```
public final boolean isWritable(int size)
```
    Description copied from interface: Buf
    
    Returns true if and only if this buffer has enough room to allow writing the specified number of elements.
    
    Specified by:
    
    isWritable in interface Buf
  - ensureAccessible
```
protected final void ensureAccessible()
```
  - add
```
public final boolean add(T t)
```
    Specified by:
    
    add in interface Collection<T>
    
    Specified by:
    
    add in interface Queue<T>
    
    Overrides:
    
    add in class AbstractQueue<T>
  - remove
```
public final T remove()
```
    Specified by:
    
    remove in interface Queue<T>
    
    Overrides:
    
    remove in class AbstractQueue<T>
  - element
```
public final T element()
```
    Specified by:
    
    element in interface Queue<T>
    
    Overrides:
    
    element in class AbstractQueue<T>
  - unfoldAndAdd
```
public boolean unfoldAndAdd(Object o)
```
    Description copied from interface: MessageBuf
    
    Unfold the specified object if necessary, and then add the unfolded objects (or the specified object if unfonding was not necessary) to this buffer. If the specified object is an object array (Object[]), this method adds the elements of the array to this buffer until null is encountered. If the specified object is null, nothing is added to this buffer. Otherwise, the specified object is added to this buffer as-is.
    
    Specified by:
    
    unfoldAndAdd in interface MessageBuf<T>
    
    Returns:
    true if one or more messages were added to this buffer. false otherwise.
  - drainTo
```
public int drainTo(Collection<? super T> c)
```
    Description copied from interface: MessageBuf
    
    Drain the content of te MessageBuf to the given Collection.
    
    Specified by:
    
    drainTo in interface MessageBuf<T>
    
    Parameters:
    c - the Collection to drain the content to
    
    Returns:
    number the number of objects which was transfered
  - drainTo
```
public int drainTo(Collection<? super T> c,
          int maxElements)
```
    Description copied from interface: MessageBuf
    
    Drain the content of te MessageBuf to the given Collection.
    
    Specified by:
    
    drainTo in interface MessageBuf<T>
    
    Parameters:
    c - the Collection to drain the content to
    maxElements - the max number of elements to drain
    
    Returns:
    number the number of objects which was transfered
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCollection<T>

Class AbstractMessageBuf<T>

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractQueue

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Queue

Methods inherited from interface java.util.Collection

Constructor Detail

AbstractMessageBuf

Method Detail

type

refCnt

retain

retain

release

release

deallocate

maxCapacity

isReadable

isReadable

isWritable

isWritable

ensureAccessible

add

remove

element

unfoldAndAdd

drainTo

drainTo

toString