A facade for iterating the readable or writable components of a Buffer.

Note

the iterator object must be closed after use. The easiest way to ensure this, is to use a try-with-resources clause.

The typical code pattern for using this API looks like the following:

try (var iteration = buffer.forEachComponent()) {
         for (var c = iteration.first(); c != null; c = c.next()) {
             ByteBuffer componentBuffer = c.readableBuffer();
             // ...
         }
     }

Note the use of the var keyword for local variables, which are required for correctly expressing the generic types used in the iteration. Following this code pattern will ensure that the components, and their parent buffer, will be correctly life-cycled.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	ComponentIterator.Next This interface exposes external iteration on components.

Method Summary

Modifier and Type	Method and Description
public T	Returns: The first component of the iteration, or `null` if there are no components. first() Get the first component of the iteration, or `null` if there are no components.
public default T	Returns: The first readable component of the iteration, or `null` if there are no readable components. firstReadable() Get the first component of the iteration that has any bytes to read, or `null` if there are no components with any readable bytes.
public default T	Returns: The first writable component of the iteration, or `null` if there are no writable components. firstWritable() Get the first component of the iteration that has any space for writing bytes, or `null` if there are no components with any spare capacity.
private static <T extends ComponentIterator.Next & BufferComponent> T	nextReadable(T component)
private static <T extends ComponentIterator.Next & BufferComponent> T	nextWritable(T component)

Inherited from io.netty5.util.SafeCloseable:: close

Method Detail

first back to summary

first	back to summary
public T first() Get the first component of the iteration, or `null` if there are no components. The object returned will implement both of the `Next` and `BufferComponent` interfaces. Returns:T The first component of the iteration, or `null` if there are no components.

public T first()

Get the first component of the iteration, or null if there are no components.

The object returned will implement both of the Next and BufferComponent interfaces.

Returns:T: The first component of the iteration, or null if there are no components.

firstReadable back to summary

firstReadable	back to summary
public default T firstReadable() Get the first component of the iteration that has any bytes to read, or `null` if there are no components with any readable bytes. The object returned will implement both of the `Next` and `BufferComponent` interfaces. Returns:T The first readable component of the iteration, or `null` if there are no readable components.

public default T firstReadable()

Get the first component of the iteration that has any bytes to read, or null if there are no components with any readable bytes.

The object returned will implement both of the Next and BufferComponent interfaces.

Returns:T: The first readable component of the iteration, or null if there are no readable components.

firstWritable back to summary

firstWritable	back to summary
public default T firstWritable() Get the first component of the iteration that has any space for writing bytes, or `null` if there are no components with any spare capacity. The object returned will implement both of the `Next` and `BufferComponent` interfaces. Returns:T The first writable component of the iteration, or `null` if there are no writable components.

public default T firstWritable()

Get the first component of the iteration that has any space for writing bytes, or null if there are no components with any spare capacity.

The object returned will implement both of the Next and BufferComponent interfaces.

Returns:T: The first writable component of the iteration, or null if there are no writable components.

nextReadable	back to summary
private static <T extends ComponentIterator.Next & BufferComponent> T nextReadable(T component)

nextWritable	back to summary
private static <T extends ComponentIterator.Next & BufferComponent> T nextWritable(T component)

io.netty5.buffer back to summary

public Interface ComponentIterator.Next

Known Direct Implementers: io.netty5.buffer.DefaultCompositeBuffer.NextComponent, io.netty5.buffer.bytebuffer.NioBuffer, io.netty5.buffer.unsafe.UnsafeBuffer

This interface exposes external iteration on components.

Method Summary

Modifier and Type	Method and Description
public < A type that implements the `Next` and `BufferComponent` interfaces. N extends ComponentIterator.Next & BufferComponent> N	Returns: The next component in the iteration, or `null` if there are no more components. next() Get the next component of the iteration, or `null` if there are no more components.
public default <N extends ComponentIterator.Next & BufferComponent> N	Returns: The next readable component of the iteration, or `null` if there are no readable components. nextReadable() Get the next component of the iteration that has any bytes to read, or `null` if there are no components with any readable bytes.
public default <N extends ComponentIterator.Next & BufferComponent> N	Returns: The next writable component of the iteration, or `null` if there are no writable components. nextWritable() Get the next component of the iteration that has any space for writing bytes, or `null` if there are no components with any spare capacity.

Method Detail

next back to summary

next	back to summary
public <N extends ComponentIterator.Next & BufferComponent> N next() Get the next component of the iteration, or `null` if there are no more components. The returned object, if any, will be of the same type as this object, and would typically be assigned to the same variable. Iteration is only valid while the `ComponentIterator` is open. Calling this method after the associated component iterator has been closed may result in undefined behaviour. Parameters <N> A type that implements the `Next` and `BufferComponent` interfaces. Returns:N The next component in the iteration, or `null` if there are no more components.

public <N extends ComponentIterator.Next & BufferComponent> N next()

Get the next component of the iteration, or null if there are no more components.

The returned object, if any, will be of the same type as this object, and would typically be assigned to the same variable.

Iteration is only valid while the ComponentIterator is open. Calling this method after the associated component iterator has been closed may result in undefined behaviour.

Parameters

<N>: A type that implements the Next and BufferComponent interfaces.

Returns:N

The next component in the iteration, or null if there are no more components.

nextReadable back to summary

nextReadable	back to summary
public default <N extends ComponentIterator.Next & BufferComponent> N nextReadable() Get the next component of the iteration that has any bytes to read, or `null` if there are no components with any readable bytes. The object returned will implement both of the `Next` and `BufferComponent` interfaces. Returns:N The next readable component of the iteration, or `null` if there are no readable components.

public default <N extends ComponentIterator.Next & BufferComponent> N nextReadable()

Get the next component of the iteration that has any bytes to read, or null if there are no components with any readable bytes.

The object returned will implement both of the Next and BufferComponent interfaces.

Returns:N: The next readable component of the iteration, or null if there are no readable components.

nextWritable back to summary

nextWritable	back to summary
public default <N extends ComponentIterator.Next & BufferComponent> N nextWritable() Get the next component of the iteration that has any space for writing bytes, or `null` if there are no components with any spare capacity. The object returned will implement both of the `Next` and `BufferComponent` interfaces. Returns:N The next writable component of the iteration, or `null` if there are no writable components.

public default <N extends ComponentIterator.Next & BufferComponent> N nextWritable()

Get the next component of the iteration that has any space for writing bytes, or null if there are no components with any spare capacity.

The object returned will implement both of the Next and BufferComponent interfaces.

Returns:N: The next writable component of the iteration, or null if there are no writable components.

public Interface ComponentIterator<T extends ComponentIterator.Next & io.netty5.buffer.BufferComponent>

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface ComponentIterator.Next

Method Summary

Method Detail