Class Iterations

  • Direct Known Subclasses:
    QueryResults

    @Deprecated(since="4.1.0")
    public class Iterations
    extends Object
    Deprecated.
    This class consists exclusively of static methods that operate on or return Iterations. It is the Iteration-equivalent of java.util.Collections.
    • Constructor Detail

      • Iterations

        public Iterations()
        Deprecated.
    • Method Detail

      • asList

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <E,​X extends ExceptionList<E> asList​(Iteration<? extends E,​X> iter)
                                                            throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Get a List containing all elements obtained from the specified iteration.
        Parameters:
        iter - the iteration to get the elements from
        Returns:
        a List containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception
      • asList

        public static <E,​X extends ExceptionList<E> asList​(CloseableIteration<? extends E,​X> iter)
                                                            throws X extends Exception
        Deprecated.
        Get a List containing all elements obtained from the specified iteration.
        Parameters:
        iter - the CloseableIteration to get the elements from
        Returns:
        a List containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception
      • asSet

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <E,​X extends ExceptionSet<E> asSet​(Iteration<? extends E,​X> iter)
                                                          throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Get a Set containing all elements obtained from the specified iteration.
        Parameters:
        iter - the iteration to get the elements from
        Returns:
        a Set containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception
      • asSet

        public static <E,​X extends ExceptionSet<E> asSet​(CloseableIteration<? extends E,​X> iter)
                                                          throws X extends Exception
        Deprecated.
        Get a Set containing all elements obtained from the specified iteration.
        Parameters:
        iter - the CloseableIteration to get the elements from
        Returns:
        a Set containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception
      • addAll

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <E,​X extends Exception,​C extends Collection<E>> C addAll​(Iteration<? extends E,​X> iter,
                                                                                           C collection)
                                                                                    throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Adds all elements from the supplied iteration to the specified collection. If the supplied iteration is an instance of CloseableIteration it is automatically closed after consumption.
        Parameters:
        iter - An iteration containing elements to add to the container. If the iteration is an instance of CloseableIteration it is automatically closed after consumption.
        collection - The collection to add the elements to.
        Returns:
        The collection object that was supplied to this method.
        Throws:
        X extends Exception
      • stream

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <T> Stream<T> stream​(Iteration<T,​? extends Exception> iteration)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Get a sequential Stream with the supplied Iteration as its source. If the source iteration is a CloseableIteration, it will be automatically closed by the stream when done. Any checked exceptions thrown at any point during stream processing will be propagated wrapped in a RuntimeException.
        Parameters:
        iteration - a source Iteration for the stream.
        Returns:
        a sequential Stream object which can be used to process the data from the source iteration.
      • stream

        public static <T> Stream<T> stream​(CloseableIteration<T,​? extends Exception> iteration)
        Deprecated.
        Get a sequential Stream with the supplied CloseableIteration as its source. The source iteration will be automatically closed by the stream when done. Any checked exceptions thrown at any point during stream processing will be propagated wrapped in a RuntimeException.
        Parameters:
        iteration - a source CloseableIteration for the stream.
        Returns:
        a sequential Stream object which can be used to process the data from the source iteration.
      • closeCloseable

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <X extends Exception> void closeCloseable​(Iteration<?,​X> iteration)
                                                         throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Closes the supplied iteration if it is an instance of CloseableIteration, otherwise the request is ignored.
        Parameters:
        iteration - The iteration that should be closed.
        Throws:
        X extends Exception
      • toString

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <X extends ExceptionString toString​(Iteration<?,​X> iteration,
                                                            String separator)
                                                     throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Converts an iteration to a string by concatenating all of the string representations of objects in the Iteration, divided by a separator.
        Parameters:
        iteration - An iteration over arbitrary objects that are expected to implement Object.toString().
        separator - The separator to insert between the object strings.
        Returns:
        A String representation of the objects provided by the supplied iteration.
        Throws:
        X extends Exception
      • toString

        public static <X extends ExceptionString toString​(CloseableIteration<?,​X> iteration,
                                                            String separator)
                                                     throws X extends Exception
        Deprecated.
        Converts a CloseableIteration to a string by concatenating all the string representations of objects in the iteration, divided by a separator.
        Parameters:
        iteration - A CloseableIteration over arbitrary objects that are expected to implement Object.toString().
        separator - The separator to insert between the object strings.
        Returns:
        A String representation of the objects provided by the supplied iteration.
        Throws:
        X extends Exception
      • toString

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <X extends Exception> void toString​(Iteration<?,​X> iteration,
                                                          String separator,
                                                          StringBuilder sb)
                                                   throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Converts an iteration to a string by concatenating all the string representations of objects in the Iteration, divided by a separator.
        Parameters:
        iteration - An iteration over arbitrary objects that are expected to implement Object.toString().
        separator - The separator to insert between the object strings.
        sb - A StringBuilder to append the iteration string to.
        Throws:
        X extends Exception
      • toString

        public static <X extends Exception> void toString​(CloseableIteration<?,​X> iteration,
                                                          String separator,
                                                          StringBuilder sb)
                                                   throws X extends Exception
        Deprecated.
        Converts a CloseableIteration to a string by concatenating all the string representations of objects in the iteration, divided by a separator.
        Parameters:
        iteration - A CloseableIteration over arbitrary objects that are expected to implement Object.toString().
        separator - The separator to insert between the object strings.
        sb - A StringBuilder to append the iteration string to.
        Throws:
        X extends Exception
      • asSet

        @Deprecated(since="4.1.0",
                    forRemoval=true)
        public static <E,​X extends ExceptionSet<E> asSet​(Iteration<? extends E,​? extends X> iteration,
                                                                 Supplier<Set<E>> setMaker)
                                                          throws X extends Exception
        Deprecated, for removal: This API element is subject to removal in a future version.
        Get a Set containing all elements obtained from the specified iteration.
        Parameters:
        iteration - the iteration to get the elements from
        setMaker - the Supplier that constructs a new set
        Returns:
        a Set containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception
      • asSet

        public static <E,​X extends ExceptionSet<E> asSet​(CloseableIteration<? extends E,​? extends X> iteration,
                                                                 Supplier<Set<E>> setMaker)
                                                          throws X extends Exception
        Deprecated.
        Get a Set containing all elements obtained from the specified iteration.
        Parameters:
        iteration - the iteration to get the elements from
        setMaker - the Supplier that constructs a new set
        Returns:
        a Set containing all elements obtained from the specified iteration.
        Throws:
        X extends Exception