ByteBufferHolder (SNF4J 1.10.0 API)

java.lang.Object
- org.snf4j.core.ByteBufferHolder

All Implemented Interfaces:

Iterable<ByteBuffer>, Collection<ByteBuffer>, List<ByteBuffer>, IByteBufferHolder
```
public class ByteBufferHolder
extends Object
implements IByteBufferHolder, List<ByteBuffer>
```
Default implementation of byte buffer holder.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Constructor and Description
`ByteBufferHolder()` Constructs an empty byte buffer holder with an initial capacity of ten.
`ByteBufferHolder(Collection<ByteBuffer> c)` Constructs a byte buffer holder containing the byte buffers of the specified collection, in the order they are returned by the collection's iterator.
`ByteBufferHolder(int initialCapacity)` Constructs an empty byte buffer holder with the specified initial capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(ByteBuffer e)`
`void`	`add(int index, ByteBuffer element)`
`boolean`	`addAll(Collection<? extends ByteBuffer> c)`
`boolean`	`addAll(int index, Collection<? extends ByteBuffer> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`ByteBuffer`	`get(int index)`
`boolean`	`hasRemaining()` Tells whether there are any bytes remaining in byte buffers stored in this holder.
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`boolean`	`isMessage()` Tells if this byte buffer holder should be treated as a message or raw bytes when it is processed thru an encoding pipeline.
`Iterator<ByteBuffer>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<ByteBuffer>`	`listIterator()`
`ListIterator<ByteBuffer>`	`listIterator(int index)`
`int`	`remaining()` Returns the total number of bytes remaining in all byte buffers stored in this holder.
`ByteBuffer`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`ByteBuffer`	`set(int index, ByteBuffer element)`
`int`	`size()`
`List<ByteBuffer>`	`subList(int fromIndex, int toIndex)`
`ByteBuffer[]`	`toArray()` Returns an array containing all of byte buffers stored in this holder in proper sequence (from first to last buffer buffer to send).
`<T> T[]`	`toArray(T[] a)`

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

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - ByteBufferHolder
```
public ByteBufferHolder()
```
    Constructs an empty byte buffer holder with an initial capacity of ten.
  - ByteBufferHolder
```
public ByteBufferHolder(int initialCapacity)
```
    Constructs an empty byte buffer holder with the specified initial capacity.
    
    Parameters:
    
    initialCapacity - the initial capacity
  - ByteBufferHolder
```
public ByteBufferHolder(Collection<ByteBuffer> c)
```
    Constructs a byte buffer holder containing the byte buffers of the specified collection, in the order they are returned by the collection's iterator.
    
    Parameters:
    
    c - the collection whose byte buffers are to be placed into this byte buffer holder
- Method Detail
  - hasRemaining
```
public boolean hasRemaining()
```
    Description copied from interface: IByteBufferHolder
    
    Tells whether there are any bytes remaining in byte buffers stored in this holder.
    
    Specified by:
    
    hasRemaining in interface IByteBufferHolder
    
    Returns:
    
    true if, and only if, there is at least one byte remaining in byte buffers stored in this holder
  - remaining
```
public int remaining()
```
    Description copied from interface: IByteBufferHolder
    
    Returns the total number of bytes remaining in all byte buffers stored in this holder.
    
    Specified by:
    
    remaining in interface IByteBufferHolder
    
    Returns:
    
    The number of total bytes remaining in all byte buffers stored in this holder
  - toArray
```
public ByteBuffer[] toArray()
```
    Description copied from interface: IByteBufferHolder
    
    Returns an array containing all of byte buffers stored in this holder in proper sequence (from first to last buffer buffer to send).
    The returned array should be "safe" in that no references to it are maintained by this holder. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
    
    Specified by:
    
    toArray in interface Collection<ByteBuffer>
    
    Specified by:
    
    toArray in interface List<ByteBuffer>
    
    Specified by:
    
    toArray in interface IByteBufferHolder
    
    Returns:
    
    an array containing all of the byte buffers in this holder in proper sequence
  - isMessage
```
public boolean isMessage()
```
    Tells if this byte buffer holder should be treated as a message or raw bytes when it is processed thru an encoding pipeline.
    When true is returned the processing will start from the last encoder in the pipeline with inbound type matching a class implementing this interface or this interface itself.
    In other case, when false is returned, the processing will start from the last encoder with inbound type that is either byte[], ByteBuffer or this interface itself.
    
    Specified by:
    
    isMessage in interface IByteBufferHolder
    
    Returns:
    
    false
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<ByteBuffer>
    
    Specified by:
    
    size in interface List<ByteBuffer>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<ByteBuffer>
    
    Specified by:
    
    isEmpty in interface List<ByteBuffer>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<ByteBuffer>
    
    Specified by:
    
    contains in interface List<ByteBuffer>
  - iterator
```
public Iterator<ByteBuffer> iterator()
```
    Specified by:
    
    iterator in interface Iterable<ByteBuffer>
    
    Specified by:
    
    iterator in interface Collection<ByteBuffer>
    
    Specified by:
    
    iterator in interface List<ByteBuffer>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<ByteBuffer>
    
    Specified by:
    
    toArray in interface List<ByteBuffer>
  - add
```
public boolean add(ByteBuffer e)
```
    Specified by:
    
    add in interface Collection<ByteBuffer>
    
    Specified by:
    
    add in interface List<ByteBuffer>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<ByteBuffer>
    
    Specified by:
    
    remove in interface List<ByteBuffer>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<ByteBuffer>
    
    Specified by:
    
    containsAll in interface List<ByteBuffer>
  - addAll
```
public boolean addAll(Collection<? extends ByteBuffer> c)
```
    Specified by:
    
    addAll in interface Collection<ByteBuffer>
    
    Specified by:
    
    addAll in interface List<ByteBuffer>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends ByteBuffer> c)
```
    Specified by:
    
    addAll in interface List<ByteBuffer>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<ByteBuffer>
    
    Specified by:
    
    removeAll in interface List<ByteBuffer>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<ByteBuffer>
    
    Specified by:
    
    retainAll in interface List<ByteBuffer>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<ByteBuffer>
    
    Specified by:
    
    clear in interface List<ByteBuffer>
  - get
```
public ByteBuffer get(int index)
```
    Specified by:
    
    get in interface List<ByteBuffer>
  - set
```
public ByteBuffer set(int index,
                      ByteBuffer element)
```
    Specified by:
    
    set in interface List<ByteBuffer>
  - add
```
public void add(int index,
                ByteBuffer element)
```
    Specified by:
    
    add in interface List<ByteBuffer>
  - remove
```
public ByteBuffer remove(int index)
```
    Specified by:
    
    remove in interface List<ByteBuffer>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<ByteBuffer>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<ByteBuffer>
  - listIterator
```
public ListIterator<ByteBuffer> listIterator()
```
    Specified by:
    
    listIterator in interface List<ByteBuffer>
  - listIterator
```
public ListIterator<ByteBuffer> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<ByteBuffer>
  - subList
```
public List<ByteBuffer> subList(int fromIndex,
                                int toIndex)
```
    Specified by:
    
    subList in interface List<ByteBuffer>

Class ByteBufferHolder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

ByteBufferHolder

ByteBufferHolder

ByteBufferHolder

Method Detail

hasRemaining

remaining

toArray

isMessage

size

isEmpty

contains

iterator

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList