public interface ComponentIterator<T extends ComponentIterator.Next>
extends SafeCloseable

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.forEachReadable()) {
          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.