| /* |
| * 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.BufferedReader; |
| import java.io.IOException; |
| import java.io.Reader; |
| import java.io.UncheckedIOException; |
| import java.nio.CharBuffer; |
| import java.nio.charset.Charset; |
| |
| import org.apache.commons.io.build.AbstractOrigin; |
| import org.apache.commons.io.build.AbstractStreamBuilder; |
| import org.apache.commons.io.function.Uncheck; |
| |
| /** |
| * A {@link BufferedReader} that throws {@link UncheckedIOException} instead of {@link IOException}. |
| * <p> |
| * To build an instance, use {@link Builder}. |
| * </p> |
| * |
| * @see Builder |
| * @see BufferedReader |
| * @see IOException |
| * @see UncheckedIOException |
| * @since 2.12.0 |
| */ |
| public final class UncheckedBufferedReader extends BufferedReader { |
| |
| // @formatter:off |
| /** |
| * Builds a new {@link UncheckedBufferedReader}. |
| * |
| * <p> |
| * Using File IO: |
| * </p> |
| * <pre>{@code |
| * UncheckedBufferedReader s = UncheckedBufferedReader.builder() |
| * .setFile(file) |
| * .setBufferSize(8192) |
| * .setCharset(Charset.defaultCharset()) |
| * .get();} |
| * </pre> |
| * <p> |
| * Using NIO Path: |
| * </p> |
| * <pre>{@code |
| * UncheckedBufferedReader s = UncheckedBufferedReader.builder() |
| * .setPath(path) |
| * .setBufferSize(8192) |
| * .setCharset(Charset.defaultCharset()) |
| * .get();} |
| * </pre> |
| * |
| * @see #get() |
| */ |
| // @formatter:on |
| public static class Builder extends AbstractStreamBuilder<UncheckedBufferedReader, Builder> { |
| |
| /** |
| * Builds a new {@link UncheckedBufferedReader}. |
| * |
| * <p> |
| * This builder use the following aspects: |
| * </p> |
| * <ul> |
| * <li>{@link Reader}</li> |
| * <li>{@link #getBufferSize()}</li> |
| * </ul> |
| * <p> |
| * You must provide an origin that can be converted to a Reader by this builder, otherwise, this call will throw an |
| * {@link UnsupportedOperationException}. |
| * </p> |
| * |
| * @return a new instance. |
| * @throws UnsupportedOperationException if the origin cannot provide a Reader. |
| * @throws IllegalStateException if the {@code origin} is {@code null}. |
| * @see AbstractOrigin#getReader(Charset) |
| * @see #getBufferSize() |
| */ |
| @Override |
| public UncheckedBufferedReader get() { |
| // This an unchecked class, so this method is as well. |
| return Uncheck.get(() -> new UncheckedBufferedReader(checkOrigin().getReader(getCharset()), getBufferSize())); |
| } |
| |
| } |
| |
| /** |
| * Constructs a new {@link Builder}. |
| * |
| * @return a new {@link Builder}. |
| */ |
| public static Builder builder() { |
| return new Builder(); |
| } |
| |
| /** |
| * Constructs a buffering character-input stream that uses an input buffer of the specified size. |
| * |
| * @param reader A Reader |
| * @param bufferSize Input-buffer size |
| * |
| * @throws IllegalArgumentException If {@code bufferSize <= 0} |
| */ |
| private UncheckedBufferedReader(final Reader reader, final int bufferSize) { |
| super(reader, bufferSize); |
| } |
| |
| /** |
| * 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 String readLine() throws UncheckedIOException { |
| return Uncheck.get(super::readLine); |
| } |
| |
| /** |
| * 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); |
| } |
| |
| } |