com.github.sviperll.io.InputStreams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chicory-core Show documentation

Basic utilities to compensate shortcomings of Java SE. Part of chicory.

There is a newer version: 0.36

/*
 * Copyright (c) 2012, Victor Nazarov 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Victor Nazarov nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.sviperll.io;

import java.io.InputStream;

public class InputStreams {
    /**
     * Return proxy input stream. Resulting input stream is the same as
     * input stream passed in arguments, except it signalized of end of file
     * when length bytes are read from it. The rest of original stream is
     * not accessible through this proxy stream.
     *
     * If length is less than 0 the original stream is returned.
     *
     * @param stream original stream to access length bytes from
     * @param length number of bytes in resulting stream
     * @return proxy stream to read length bytes from original stream
     */
    public static InputStream truncated(InputStream stream, int length) {
        return new TruncatedInputStream(stream, length);
    }

    private InputStreams() {
    }
}