diff options
Diffstat (limited to 'src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java')
-rw-r--r-- | src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java new file mode 100644 index 00000000..794630a0 --- /dev/null +++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java @@ -0,0 +1,131 @@ +/* + * 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.apache.commons.io.input; + +import java.io.FilterReader; +import java.io.IOException; +import java.io.Reader; +import java.io.UncheckedIOException; +import java.nio.CharBuffer; + +import org.apache.commons.io.function.Uncheck; + +/** + * A {@link FilterReader} that throws {@link UncheckedIOException} instead of {@link IOException}. + * + * @see FilterReader + * @see IOException + * @see UncheckedIOException + * @since 2.12.0 + */ +public class UncheckedFilterReader extends FilterReader { + + /** + * Creates a new filtered reader. + * + * @param reader a Reader object providing the underlying stream. + * @return a new UncheckedFilterReader. + * @throws NullPointerException if {@code reader} is {@code null}. + */ + public static UncheckedFilterReader on(final Reader reader) { + return new UncheckedFilterReader(reader); + } + + /** + * Creates a new filtered reader. + * + * @param reader a Reader object providing the underlying stream. + * @throws NullPointerException if {@code reader} is {@code null}. + */ + public UncheckedFilterReader(final Reader reader) { + super(reader); + } + + /** + * 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 void mark(final int readAheadLimit) throws UncheckedIOException { + Uncheck.accept(super::mark, readAheadLimit); + } + + /** + * 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 char[] cbuf) throws UncheckedIOException { + return Uncheck.apply(super::read, cbuf); + } + + /** + * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}. + */ + @Override + public int read(final char[] cbuf, final int off, final int len) throws UncheckedIOException { + return Uncheck.apply(super::read, cbuf, off, len); + } + + /** + * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}. + */ + @Override + public int read(final CharBuffer target) throws UncheckedIOException { + return Uncheck.apply(super::read, target); + } + + /** + * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}. + */ + @Override + public boolean ready() throws UncheckedIOException { + return Uncheck.get(super::ready); + } + + /** + * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}. + */ + @Override + public 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); + } + +} |