netty5/buffer/src/main/java/io/netty/buffer/CompositeByteBuf.java

/*
 * Copyright 2012 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.netty.buffer;

import java.util.List;

public interface CompositeByteBuf extends ByteBuf, Iterable<ByteBuf> {

    void addComponent(ByteBuf buffer);
    void addComponent(int cIndex, ByteBuf buffer);

    void addComponents(ByteBuf... buffers);
    void addComponents(Iterable<ByteBuf> buffers);
    void addComponents(int cIndex, ByteBuf... buffers);
    void addComponents(int cIndex, Iterable<ByteBuf> buffers);

    void removeComponent(int cIndex);
    void removeComponents(int cIndex, int numComponents);

    int numComponents();
    int maxNumComponents();

    ByteBuf component(int cIndex);
    ByteBuf componentAtOffset(int offset);

    void discardReadComponents();
    void consolidate();
    void consolidate(int cIndex, int numComponents);

    int toComponentIndex(int offset);
    int toByteIndex(int cIndex);

    /**
     * Same with {@link #slice(int, int)} except that this method returns a list.
     */
    List<ByteBuf> decompose(int offset, int length);
}