WrappedInputStream.java

/**
 * VMware Continuent Tungsten Replicator
 * Copyright (C) 2015 VMware, Inc. All rights reserved.
 *
 * 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.
 *
 * Initial developer(s): Robert Hodges
 * Contributor(s): 
 */

package com.continuent.tungsten.common.io;

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

/**
 * Encapsulates an InputStream in order to provide additional management of
 * stream capabilities. This class overrides all superclass methods to ensure a
 * faithful representation of the wrapped stream semantics.
 * 
 * @author <a href="mailto:robert.hodges@continuent.com">Robert Hodges</a>
 */
public class WrappedInputStream extends InputStream
{
    private final InputStream in;
    private final boolean     deterministic;

    /**
     * Creates a new wrapped input stream.
     * 
     * @param in InputStream instance to be wrapped
     * @param deterministic If true the stream gives accurate availability
     *            counts
     */
    public WrappedInputStream(InputStream in, boolean deterministic)
    {
        this.in = in;
        this.deterministic = deterministic;
    }

    /**
     * Returns true if {@link #available()} returns a number that can be trusted
     * for buffering.
     */
    public boolean isDeterministic()
    {
        return deterministic;
    }

    /**
     * @see java.io.InputStream#available()
     */
    public int available() throws IOException
    {
        return in.available();
    }

    /**
     * @see java.io.InputStream#close()
     */
    public void close() throws IOException
    {
        in.close();
    }

    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public boolean equals(Object obj)
    {
        return in.equals(obj);
    }

    /**
     * @see java.lang.Object#hashCode()
     */
    public int hashCode()
    {
        return in.hashCode();
    }

    /**
     * @see java.io.InputStream#mark(int)
     */
    public void mark(int arg0)
    {
        in.mark(arg0);
    }

    /**
     * @see java.io.InputStream#markSupported()
     */
    public boolean markSupported()
    {
        return in.markSupported();
    }

    /**
     * @see java.io.InputStream#read()
     */
    public int read() throws IOException
    {
        return in.read();
    }

    /**
     * @see java.io.InputStream#read(byte[], int, int)
     */
    public int read(byte[] arg0, int arg1, int arg2) throws IOException
    {
        return in.read(arg0, arg1, arg2);
    }

    /**
     * @see java.io.InputStream#read(byte[])
     */
    public int read(byte[] arg0) throws IOException
    {
        return in.read(arg0);
    }

    /**
     * @see java.io.InputStream#reset()
     */
    public void reset() throws IOException
    {
        in.reset();
    }

    /**
     * @see java.io.InputStream#skip(long)
     */
    public long skip(long arg0) throws IOException
    {
        return in.skip(arg0);
    }

    /**
     * @see java.lang.Object#toString()
     */
    public String toString()
    {
        return in.toString();
    }
}