com.signalfx.shaded.apache.commons.io.input.UncheckedFilterInputStream Maven / Gradle / Ivy
/*
* 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 com.signalfx.shaded.apache.commons.io.input;
import java.io.BufferedReader;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import com.signalfx.shaded.apache.commons.io.build.AbstractStreamBuilder;
import com.signalfx.shaded.apache.commons.io.function.Uncheck;
/**
* A {@link BufferedReader} that throws {@link UncheckedIOException} instead of {@link IOException}.
*
* To build an instance, see {@link Builder}.
*
*
* @see BufferedReader
* @see IOException
* @see UncheckedIOException
* @since 2.12.0
*/
public final class UncheckedFilterInputStream extends FilterInputStream {
/**
* Builds a new {@link UncheckedFilterInputStream} instance.
*
* Using File IO:
*
* {@code
* UncheckedFilterInputStream s = UncheckedFilterInputStream.builder()
* .setFile(file)
* .get();}
*
*
* Using NIO Path:
*
* {@code
* UncheckedFilterInputStream s = UncheckedFilterInputStream.builder()
* .setPath(path)
* .get();}
*
*/
public static class Builder extends AbstractStreamBuilder {
/**
* Constructs a new instance.
*
* This builder use the aspect InputStream and OpenOption[].
*
*
* You must provide an origin that can be converted to an InputStream by this builder, otherwise, this call will throw an
* {@link UnsupportedOperationException}.
*
*
* @return a new instance.
* @throws UnsupportedOperationException if the origin cannot provide an InputStream.
* @see #getInputStream()
*/
@Override
public UncheckedFilterInputStream get() {
// This an unchecked class, so this method is as well.
return Uncheck.get(() -> new UncheckedFilterInputStream(getInputStream()));
}
}
/**
* Constructs a new {@link Builder}.
*
* @return a new {@link Builder}.
*/
public static Builder builder() {
return new Builder();
}
/**
* Creates a {@link UncheckedFilterInputStream}.
*
* @param inputStream the underlying input stream, or {@code null} if this instance is to be created without an
* underlying stream.
*/
private UncheckedFilterInputStream(final InputStream inputStream) {
super(inputStream);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public int available() throws UncheckedIOException {
return Uncheck.get(super::available);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public void close() throws UncheckedIOException {
Uncheck.run(super::close);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public int read() throws UncheckedIOException {
return Uncheck.get(super::read);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public int read(final byte[] b) throws UncheckedIOException {
return Uncheck.apply(super::read, b);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public int read(final byte[] b, final int off, final int len) throws UncheckedIOException {
return Uncheck.apply(super::read, b, off, len);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public synchronized void reset() throws UncheckedIOException {
Uncheck.run(super::reset);
}
/**
* Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
*/
@Override
public long skip(final long n) throws UncheckedIOException {
return Uncheck.apply(super::skip, n);
}
}