Package org.osgi.util.function

Interface Supplier<T>

  • Type Parameters:
    T - The type of the function output.
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    @ConsumerType
@FunctionalInterface
public interface Supplier<T>
    A function that produces a result.

    This is a functional interface and can be used as the assignment target for a lambda expression or method reference.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      static <T> java.util.function.Supplier<T> asJavaSupplier​(Supplier<T> wrapped)
      Returns a java.util.function.Supplier which wraps the specified Supplier and throws any thrown exceptions.
      static <T> java.util.function.Supplier<T> asJavaSupplierOrElse​(Supplier<T> wrapped, T orElse)
      Returns a java.util.function.Supplier which wraps the specified Supplier and the specified value.
      static <T> java.util.function.Supplier<T> asJavaSupplierOrElseGet​(Supplier<T> wrapped, java.util.function.Supplier<? extends T> orElseGet)
      Returns a java.util.function.Supplier which wraps the specified Supplier and the specified java.util.function.Supplier.
      static <T> Supplier<T> asSupplier​(java.util.function.Supplier<T> wrapped)
      Returns a Supplier which wraps the specified java.util.function.Supplier.
      T get()
      Returns a value.

    • Method Detail

      • get

        T get()
throws java.lang.Exception
        Returns a value.
        Returns:
        The output of this function.
        Throws:
        java.lang.Exception - An exception thrown by the method.

      • asJavaSupplier

        static <T> java.util.function.Supplier<T> asJavaSupplier​(Supplier<T> wrapped)
        Returns a java.util.function.Supplier which wraps the specified Supplier and throws any thrown exceptions.

        The returned java.util.function.Supplier will throw any exception thrown by the wrapped Supplier.

        Type Parameters:
        T - The type of the function output.
        Parameters:
        wrapped - The Supplier to wrap. Must not be null.
        Returns:
        A java.util.function.Supplier which wraps the specified Supplier.

      • asJavaSupplierOrElse

        static <T> java.util.function.Supplier<T> asJavaSupplierOrElse​(Supplier<T> wrapped,
                                                               T orElse)
        Returns a java.util.function.Supplier which wraps the specified Supplier and the specified value.

        If the the specified Supplier throws an Exception, the the specified value is returned.

        Type Parameters:
        T - The type of the function output.
        Parameters:
        wrapped - The Supplier to wrap. Must not be null.
        orElse - The value to return if the specified Supplier throws an Exception.
        Returns:
        A java.util.function.Supplier which wraps the specified Supplier and the specified value.

      • asJavaSupplierOrElseGet

        static <T> java.util.function.Supplier<T> asJavaSupplierOrElseGet​(Supplier<T> wrapped,
                                                                  java.util.function.Supplier<? extends T> orElseGet)
        Returns a java.util.function.Supplier which wraps the specified Supplier and the specified java.util.function.Supplier.

        If the the specified Supplier throws an Exception, the value returned by the specified java.util.function.Supplier is returned.

        Type Parameters:
        T - The type of the function output.
        Parameters:
        wrapped - The Supplier to wrap. Must not be null.
        orElseGet - The java.util.function.Supplier to call for a return value if the specified Supplier throws an Exception.
        Returns:
        A java.util.function.Supplier which wraps the specified Supplier and the specified java.util.function.Supplier.

      • asSupplier

        static <T> Supplier<T> asSupplier​(java.util.function.Supplier<T> wrapped)
        Returns a Supplier which wraps the specified java.util.function.Supplier.
        Type Parameters:
        T - The type of the function output.
        Parameters:
        wrapped - The java.util.function.Supplier to wrap. Must not be null.
        Returns:
        A Supplier which wraps the specified java.util.Supplier.Function.