Package nbbrd.io.function

Interface IOFunction<T,R>

Type Parameters:
T - the type of the input to the function
R - the type of the result of the function
All Known Subinterfaces:
IOUnaryOperator<T>
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface IOFunction<T,R>
Represents a function that accepts one argument and produces a result.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <V> @NonNull IOFunction<T,V>
    andThen(@NonNull IOFunction<? super R,? extends V> after)
    Returns a composed function that first applies this function to its input, and then applies the after function to the result.
    R
    applyWithIO(T t)
    Applies this function to the given argument.
    default @NonNull Function<T,R>
    asUnchecked()
     
    static <T, R> @NonNull IOFunction<T,R>
    checked(@NonNull Function<T,R> func)
     
    default <V> @NonNull IOFunction<V,R>
    compose(@NonNull IOFunction<? super V,? extends T> before)
    Returns a composed function that first applies the before function to its input, and then applies this function to the result.
    static <T> @NonNull IOFunction<T,T>
    identity()
    Returns a function that always returns its input argument.
    static <T, R> @NonNull IOFunction<T,R>
    of(@Nullable R r)
     
    static <T, R> @NonNull Function<T,R>
    unchecked(@NonNull IOFunction<T,R> o)
     

  • Method Details

    • applyWithIO

      @JdkWithIO R applyWithIO(T t) throws IOException
      Applies this function to the given argument.
      Parameters:
      t - the function argument
      Returns:
      the function result
      Throws:
      IOException - if an I/O error occurs

    • compose

      @JdkWithIO @NonNull default <V> @NonNull IOFunction<V,R> compose(@NonNull @NonNull IOFunction<? super V,? extends T> before)
      Returns a composed function that first applies the before function to its input, and then applies this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
      Type Parameters:
      V - the type of input to the before function, and to the composed function
      Parameters:
      before - the function to apply before this function is applied
      Returns:
      a composed function that first applies the before function and then applies this function
      Throws:
      NullPointerException - if before is null
      See Also:

    • andThen

      @JdkWithIO @NonNull default <V> @NonNull IOFunction<T,V> andThen(@NonNull @NonNull IOFunction<? super R,? extends V> after)
      Returns a composed function that first applies this function to its input, and then applies the after function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
      Type Parameters:
      V - the type of output of the after function, and of the composed function
      Parameters:
      after - the function to apply after this function is applied
      Returns:
      a composed function that first applies this function and then applies the after function
      Throws:
      NullPointerException - if after is null
      See Also:

    • asUnchecked

      @NonNull default @NonNull Function<T,R> asUnchecked()

    • unchecked

      @NonNull static <T, R> @NonNull Function<T,R> unchecked(@NonNull @NonNull IOFunction<T,R> o)

    • checked

      @NonNull static <T, R> @NonNull IOFunction<T,R> checked(@NonNull @NonNull Function<T,R> func)

    • identity

      @JdkWithIO @NonNull static <T> @NonNull IOFunction<T,T> identity()
      Returns a function that always returns its input argument.
      Type Parameters:
      T - the type of the input and output objects to the function
      Returns:
      a function that always returns its input argument

    • of

      @NonNull static <T, R> @NonNull IOFunction<T,R> of(@Nullable R r)