com.swirlds.common.io.extendable.InputStreamExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
 *
 * Licensed 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 com.swirlds.common.io.extendable;

import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;

/**
 * An object that extends the functionality of an {@link InputStream}.
 */
public interface InputStreamExtension extends Closeable {

    /**
     * Initialize the stream extension.
     *
     * @param baseStream
     * 		the base stream that is being extended
     */
    void init(final InputStream baseStream);

    /**
     * This method is called when the {@link InputStream#read()} is invoked on the underlying stream.
     * This method is required to eventually call {@link InputStream#read()} on the base stream.
     *
     * @return the value returned by {@link InputStream#read()}
     * @throws IOException
     * 		if there is a problem with the read
     */
    int read() throws IOException;

    /**
     * This method is called when the {@link InputStream#read(byte[], int, int)} is invoked on the underlying stream.
     * This method is required to eventually call {@link InputStream#read(byte[], int, int)} on the base stream.
     *
     * @param bytes
     * 		the array where bytes should be written
     * @param offset
     * 		the offset in the byte array where bytes should be written
     * @param length
     * 		the number of bytes to read
     * @return the value returned by {@link InputStream#read(byte[], int, int)}
     * @throws IOException
     * 		if there is a problem with the read
     */
    int read(byte[] bytes, int offset, int length) throws IOException;

    /**
     * This method is called when the {@link InputStream#readNBytes(int)} is invoked on the underlying stream.
     * This method is required to eventually call {@link InputStream#readNBytes(int)} on the base stream.
     *
     * @param length
     * 		the number of bytes to read
     * @return the value returned by {@link InputStream#readNBytes(int)}
     * @throws IOException
     * 		if there is a problem with the read
     */
    byte[] readNBytes(int length) throws IOException;

    /**
     * This method is called when the {@link InputStream#readNBytes(byte[], int, int)} is invoked on the underlying
     * stream. This method is required to eventually call {@link InputStream#readNBytes(byte[], int, int)} on the
     * base stream.
     *
     * @param offset
     * 		the offset in the byte array where bytes should be written
     * @param length
     * 		the number of bytes to read
     * @return the value returned by {@link InputStream#readNBytes(byte[], int, int)}
     * @throws IOException
     * 		if there is a problem with the read
     */
    int readNBytes(byte[] bytes, int offset, int length) throws IOException;
}