AbstractLineEndingInputStream.java

/*
 * 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
 *
 *      https://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.apache.commons.io.input;

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

/**
 * Abstracts {@link UnixLineEndingInputStream} and {@link WindowsLineEndingInputStream} to reduce duplication.
 */
abstract class AbstractLineEndingInputStream extends InputStream {

    boolean atEos;

    boolean atSlashCr;

    boolean atSlashLf;

    final InputStream in;

    final boolean lineFeedAtEos;

    /**
     * Constructs an input stream that filters another stream
     *
     * @param inputStream   The input stream to wrap.
     * @param lineFeedAtEos true to ensure that the file ends with LF.
     */
    AbstractLineEndingInputStream(final InputStream inputStream, final boolean lineFeedAtEos) {
        this.in = inputStream;
        this.lineFeedAtEos = lineFeedAtEos;
    }

    /**
     * Closes the stream. Also closes the underlying stream.
     *
     * @throws IOException If an I/O error occurs.
     */
    @Override
    public void close() throws IOException {
        super.close();
        in.close();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public synchronized void mark(final int readLimit) {
        throw UnsupportedOperationExceptions.mark();
    }
}