/*
    *  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.BufferedReader;
  import java.io.FilterInputStream;
  import java.io.IOException;
  import java.io.UncheckedIOException;
  
  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 UncheckedFilterInputStream extends FilterInputStream {
  
      // @formatter:off
      /**
       * Builds a new {@link UncheckedFilterInputStream}.
       *
       * <p>
       * Using File IO:
       * </p>
       * <pre>{@code
       * UncheckedFilterInputStream s = UncheckedFilterInputStream.builder()
       *   .setFile(file)
       *   .get();}
       * </pre>
       * <p>
       * Using NIO Path:
       * </p>
       * <pre>{@code
       * UncheckedFilterInputStream s = UncheckedFilterInputStream.builder()
       *   .setPath(path)
       *   .get();}
       * </pre>
       *
       * @see #get()
       */
      // @formatter:on
      public static class Builder extends AbstractStreamBuilder<UncheckedFilterInputStream, Builder> {
  
          /**
           * Constructs a new builder of {@link UncheckedFilterInputStream}.
           */
          public Builder() {
              // empty
          }
  
          /**
           * Builds a new {@link UncheckedFilterInputStream}.
           * <p>
           * You must set an aspect that supports {@link #getInputStream()} on this builder, otherwise, this method throws an exception.
           * </p>
           * <p>
           * This builder uses the following aspects:
           * </p>
           * <ul>
           * <li>{@link #getInputStream()} gets the target aspect.</li>
           * </ul>
           *
           * @return a new instance.
           * @throws UnsupportedOperationException if the origin cannot provide an {@link #getInputStream()}.
           * @see #getInputStream()
           * @see #getUnchecked()
           */
          @Override
          public UncheckedFilterInputStream get() {
              // This an unchecked class, so this method is as well.
              return Uncheck.get(() -> new UncheckedFilterInputStream(this));
          }
  
      }
  
     /**
      * Constructs a new {@link Builder}.
      *
      * @return a new {@link Builder}.
      */
     public static Builder builder() {
         return new Builder();
     }
 
     /**
      * Constructs a {@link UncheckedFilterInputStream}.
      *
      * @param builder A builder providing the underlying input stream.
      * @throws IOException
      */
     @SuppressWarnings("resource") // caller closes
     private UncheckedFilterInputStream(final Builder builder) throws IOException {
         super(builder.getInputStream());
     }
 
     /**
      * Calls this method's super and rethrow {@link IOException} as {@link UncheckedIOException}.
      */
     @Override
     public int available() throws UncheckedIOException {
         return Uncheck.getAsInt(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.getAsInt(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);
     }
 
 }