NodeStream (xml 1.0.0 API)

All Superinterfaces:

java.lang.AutoCloseable, net.kyori.lunar.CheckedAutoCloseable
```
public interface NodeStream
extends net.kyori.lunar.CheckedAutoCloseable
```
A stream of nodes.

See Also:

Stream

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <R,A> R`	`collect(@NonNull java.util.stream.Collector<? super Node,A,R> collector)` Performs a mutable reduction operation on the nodes of this stream using a `Collector`.
`static @NonNull NodeStream`	`concat(@NonNull NodeStream a, @NonNull NodeStream b)` Creates a lazily concatenated node stream whose elements are all the elements of the first stream followed by all the elements of the second stream.
`static @NonNull NodeStream`	`empty()` Creates an empty node stream.
`@NonNull NodeStream`	`filter(@NonNull java.util.function.Predicate<? super Node> predicate)` Returns a stream consisting of the nodes of this stream that match the given predicate.
`default @NonNull java.util.Optional<Node>`	`findAny()` Returns an `Optional` describing some node of the stream, or an empty `Optional` if the stream is empty.
`default @NonNull java.util.Optional<Node>`	`findFirst()` Returns an `Optional` describing the first node of this stream, or an empty `Optional` if the stream is empty.
`@NonNull NodeStream`	`flatMap(@NonNull java.util.function.Function<? super Node,? extends NodeStream> function)` Returns a stream consisting of the results of replacing each node of this stream with the contents of a mapped stream produced by applying the provided mapping function to each node.
`default void`	`forEach(@NonNull java.util.function.Consumer<? super Node> action)` Performs an action for each node of this stream.
`default <R> java.util.stream.Stream<R>`	`map(java.util.function.Function<? super Node,? extends R> mapper)` Returns a stream consisting of the results of applying the given function to the nodes of this stream.
`default @NonNull NodeStream`	`named(@NonNull java.util.Collection<java.lang.String> names)` Returns a stream consisting of the nodes of this stream whose name is in `names`.
`default @NonNull NodeStream`	`named(java.lang.String... names)` Returns a stream consisting of the nodes of this stream whose name is in `names`.
`default @NonNull NodeStream`	`named(@NonNull java.lang.String name)` Returns a stream consisting of the nodes of this stream that are named `name`.
`static @NonNull NodeStream`	`of(@NonNull Node node)` Creates a node stream consisting of a single node.
`static @NonNull NodeStream`	`of(@NonNull java.util.stream.Stream<Node> stream)` Creates a node stream from a stream of nodes.
`default @NonNull NodeStreamElement<Node>`	`one()` Gets a stream element representing a single node.
`@NonNull java.util.stream.Stream<Node>`	`stream()` Gets the backing stream.

Methods inherited from interface net.kyori.lunar.CheckedAutoCloseable
close

- Method Detail
  - empty
```
static @NonNull NodeStream empty()
```
    Creates an empty node stream.
    
    Returns:
    
    a node stream
  - of
```
static @NonNull NodeStream of(@NonNull Node node)
```
    Creates a node stream consisting of a single node.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    a node stream
  - of
```
static @NonNull NodeStream of(@NonNull java.util.stream.Stream<Node> stream)
```
    Creates a node stream from a stream of nodes.
    
    Parameters:
    
    stream - the stream
    
    Returns:
    
    a node stream
  - concat
```
static @NonNull NodeStream concat(@NonNull NodeStream a,
                                  @NonNull NodeStream b)
```
    Creates a lazily concatenated node stream whose elements are all the elements of the first stream followed by all the elements of the second stream.
    
    Parameters:
    
    a - the first node stream
    
    b - the second node stream
    
    Returns:
    
    a node stream representing the concatenation of the two streams
  - stream
```
@NonNull java.util.stream.Stream<Node> stream()
```
    Gets the backing stream.
    
    Returns:
    
    the stream
  - filter
```
@NonNull NodeStream filter(@NonNull java.util.function.Predicate<? super Node> predicate)
```
    Returns a stream consisting of the nodes of this stream that match the given predicate.
    
    Parameters:
    
    predicate - a non-interfering, stateless predicate to apply to each node to determine if it should be included
    
    Returns:
    
    a new stream
    
    See Also:
    
    Stream.filter(Predicate)
  - named
```
default @NonNull NodeStream named(@NonNull java.lang.String name)
```
    Returns a stream consisting of the nodes of this stream that are named name.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    a new stream
  - named
```
default @NonNull NodeStream named(java.lang.String... names)
```
    Returns a stream consisting of the nodes of this stream whose name is in names.
    
    Parameters:
    
    names - the names
    
    Returns:
    
    a new stream
  - named
```
default @NonNull NodeStream named(@NonNull java.util.Collection<java.lang.String> names)
```
    Returns a stream consisting of the nodes of this stream whose name is in names.
    
    Parameters:
    
    names - the names
    
    Returns:
    
    a new stream
  - map
```
default <R> java.util.stream.Stream<R> map(java.util.function.Function<? super Node,? extends R> mapper)
```
    Returns a stream consisting of the results of applying the given function to the nodes of this stream.
    
    Type Parameters:
    
    R - the type of the new stream
    
    Parameters:
    
    mapper - a non-interfering, stateless function to apply to each node
    
    Returns:
    
    a new stream
  - flatMap
```
@NonNull NodeStream flatMap(@NonNull java.util.function.Function<? super Node,? extends NodeStream> function)
```
    Returns a stream consisting of the results of replacing each node of this stream with the contents of a mapped stream produced by applying the provided mapping function to each node.
    
    Parameters:
    
    function - a non-interfering, stateless function to apply to each node which produces a stream of new values
    
    Returns:
    
    a new stream
    
    See Also:
    
    Stream.flatMap(Function)
  - forEach
```
default void forEach(@NonNull java.util.function.Consumer<? super Node> action)
```
    Performs an action for each node of this stream.
    
    Parameters:
    
    action - a non-interfering action to perform on the nodes
    
    See Also:
    
    Stream.forEach(Consumer)
  - collect
```
default <R,A> R collect(@NonNull java.util.stream.Collector<? super Node,A,R> collector)
```
    Performs a mutable reduction operation on the nodes of this stream using a Collector.
    
    Type Parameters:
    
    R - the type of the result
    
    A - the intermediate accumulation type of the Collector
    
    Parameters:
    
    collector - the collector describing the reduction
    
    Returns:
    
    the result of the reduction
    
    See Also:
    
    Stream.collect(Collector)
  - findAny
```
default @NonNull java.util.Optional<Node> findAny()
```
    Returns an Optional describing some node of the stream, or an empty Optional if the stream is empty.
    
    Returns:
    
    an optional describing some node of the stream, or an empty optional if the stream is empty
    
    See Also:
    
    Stream.findAny()
  - findFirst
```
default @NonNull java.util.Optional<Node> findFirst()
```
    Returns an Optional describing the first node of this stream, or an empty Optional if the stream is empty.
    
    Returns:
    
    an optional describing the first node of this stream, or an empty optional if the stream is empty
    
    See Also:
    
    Stream.findFirst()
  - one
```
default @NonNull NodeStreamElement<Node> one()
```
    Gets a stream element representing a single node.
    
    Returns:
    
    a stream element representing a single node
    
    Throws:
    
    java.lang.IllegalArgumentException - if the stream consists of two or more nodes

Interface NodeStream

Method Summary

Methods inherited from interface net.kyori.lunar.CheckedAutoCloseable

Method Detail

empty

of

of

concat

stream

filter

named

named

named

map

flatMap

forEach

collect

findAny

findFirst

one