org.apache.commons.io.function

## Class Uncheck

- java.lang.Object
- - org.apache.commons.io.function.Uncheck

-     public final class Uncheck
      extends Object

  Unchecks calls by throwing `UncheckedIOException` instead of `IOException`.
  Since:
    2.12.0

- - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static <T,U> void` | `accept(IOBiConsumer<T,U> consumer, T t, U u)` Accepts an IO consumer with the given arguments.
    `static <T> void` | `accept(IOConsumer<T> consumer, T t)` Accepts an IO consumer with the given argument.
    `static <T,U,V> void` | `accept(IOTriConsumer<T,U,V> consumer, T t, U u, V v)` Accepts an IO consumer with the given arguments.
    `static <T,U,R> R` | `apply(IOBiFunction<T,U,R> function, T t, U u)` Applies an IO function with the given arguments.
    `static <T,R> R` | `apply(IOFunction<T,R> function, T t)` Applies an IO function with the given arguments.
    `static <T,U,V,W,R> R` | `apply(IOQuadFunction<T,U,V,W,R> function, T t, U u, V v, W w)` Applies an IO quad-function with the given arguments.
    `static <T,U,V,R> R` | `apply(IOTriFunction<T,U,V,R> function, T t, U u, V v)` Applies an IO tri-function with the given arguments.
    `static <T> int` | `compare(IOComparator<T> comparator, T t, T u)` Compares the arguments with the comparator.
    `static <T> T` | `get(IOSupplier<T> supplier)` Gets the result from an IO supplier.
    `static void` | `run(IORunnable runnable)` Runs an IO runnable.
    `static <T> boolean` | `test(IOPredicate<T> predicate, T t)` Tests an IO predicate.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### accept

          public static <T,U> void accept(IOBiConsumer<T,U> consumer,
                                          T t,
                                          U u)

      Accepts an IO consumer with the given arguments.
      Type Parameters:
        `T` - the first input type.
        `U` - the second input type.
      Parameters:
        `t` - the first input argument.
        `u` - the second input argument.
        `consumer` - Consumes the value.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### accept

          public static <T> void accept(IOConsumer<T> consumer,
                                        T t)

      Accepts an IO consumer with the given argument.
      Type Parameters:
        `T` - the input type.
      Parameters:
        `t` - the input argument.
        `consumer` - Consumes the value.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### accept

          public static <T,U,V> void accept(IOTriConsumer<T,U,V> consumer,
                                            T t,
                                            U u,
                                            V v)

      Accepts an IO consumer with the given arguments.
      Type Parameters:
        `T` - the first input type.
        `U` - the second input type.
        `V` - the third input type.
      Parameters:
        `t` - the first input argument.
        `u` - the second input argument.
        `v` - the third input argument.
        `consumer` - Consumes the value.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### apply

          public static <T,U,R> R apply(IOBiFunction<T,U,R> function,
                                        T t,
                                        U u)

      Applies an IO function with the given arguments.
      Type Parameters:
        `T` - the first function argument type.
        `U` - the second function argument type.
        `R` - the return type.
      Parameters:
        `function` - the function.
        `t` - the first function argument.
        `u` - the second function argument.
      Returns:
        the function result.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### apply

          public static <T,R> R apply(IOFunction<T,R> function,
                                      T t)

      Applies an IO function with the given arguments.
      Type Parameters:
        `T` - the first function argument type.
        `R` - the return type.
      Parameters:
        `function` - the function.
        `t` - the first function argument.
      Returns:
        the function result.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### apply

          public static <T,U,V,W,R> R apply(IOQuadFunction<T,U,V,W,R> function,
                                            T t,
                                            U u,
                                            V v,
                                            W w)

      Applies an IO quad-function with the given arguments.
      Type Parameters:
        `T` - the first function argument type.
        `U` - the second function argument type.
        `V` - the third function argument type.
        `W` - the fourth function argument type.
        `R` - the return type.
      Parameters:
        `function` - the function.
        `t` - the first function argument.
        `u` - the second function argument.
        `v` - the third function argument.
        `w` - the fourth function argument.
      Returns:
        the function result.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### apply

          public static <T,U,V,R> R apply(IOTriFunction<T,U,V,R> function,
                                          T t,
                                          U u,
                                          V v)

      Applies an IO tri-function with the given arguments.
      Type Parameters:
        `T` - the first function argument type.
        `U` - the second function argument type.
        `V` - the third function argument type.
        `R` - the return type.
      Parameters:
        `function` - the function.
        `t` - the first function argument.
        `u` - the second function argument.
        `v` - the third function argument.
      Returns:
        the function result.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### compare

          public static <T> int compare(IOComparator<T> comparator,
                                        T t,
                                        T u)

      Compares the arguments with the comparator.
      Type Parameters:
        `T` - the first function argument type.
      Parameters:
        `comparator` - the function.
        `t` - the first function argument.
        `u` - the second function argument.
      Returns:
        the comparator result.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### get

          public static <T> T get(IOSupplier<T> supplier)

      Gets the result from an IO supplier.
      Type Parameters:
        `T` - the return type of the operations.
      Parameters:
        `supplier` - Supplies the return value.
      Returns:
        result from the supplier.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### run

          public static void run(IORunnable runnable)

      Runs an IO runnable.
      Parameters:
        `runnable` - The runnable to run.
      Throws:
        `UncheckedIOException` - if an I/O error occurs.

    - #### test

          public static <T> boolean test(IOPredicate<T> predicate,
                                         T t)

      Tests an IO predicate.
      Type Parameters:
        `T` - the type of the input to the predicate.
      Parameters:
        `predicate` - the predicate.
        `t` - the input to the predicate.
      Returns:
        `true` if the input argument matches the predicate, otherwise `false`.

Copyright © 2002–2023 The Apache Software Foundation. All rights reserved.