/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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 org.openide.util.io;

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


/**
 * Input stream that is always empty.
 * @author Ales Novak
 */
public class NullInputStream extends InputStream {
    /**
     * True if attempting to read from the stream should throw an {@link IOException}.
     * False to simply return end of file.
     */
    public boolean throwException;

    /** Create an empty null input stream. */
    public NullInputStream() {
    }

    public int read() throws IOException {
        if (throwException) {
            throw new IOException();
        }

        return -1;
    }
}
