1 /*
2 * Copyright 2021 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.buffer.api;
17
18 import java.nio.ByteBuffer;
19
20 /**
21 * A processor of {@linkplain WritableComponent writable components}.
22 */
23 @FunctionalInterface
24 public interface WritableComponentProcessor<E extends Exception> {
25 /**
26 * Process the given component at the given index in the
27 * {@link Buffer#forEachWritable(int, WritableComponentProcessor)} iteration}.
28 * <p>
29 * The component object itself is only valid during this call, but the {@link ByteBuffer byte buffers}, arrays, and
30 * native address pointers obtained from it, will be valid until any {@link Buffer#isOwned() ownership} requiring
31 * operation is performed on the buffer.
32 *
33 * @param index The current index of the given buffer component, based on the initial index passed to the
34 * {@link Buffer#forEachWritable(int, WritableComponentProcessor)} method.
35 * @param component The current buffer component being processed.
36 * @return {@code true} if the iteration should continue and more components should be processed, otherwise
37 * {@code false} to stop the iteration early.
38 */
39 boolean process(int index, WritableComponent component) throws E;
40 }