net.lenni0451.reflect.stream.field

Class FieldStream

java.lang.Object

net.lenni0451.reflect.stream.field.FieldStream

public class FieldStream
extends java.lang.Object

A stream of all fields of a class and super classes (if wanted).
The fields of super classes are after the fields of the class itself (descending order).

Constructor Summary

Constructors

Constructor and Description
FieldStream(RStream parent, boolean withSuper)

Method Summary

Modifier and Type	Method and Description
FieldWrapper	by(int index) Get a field by the given index.
FieldWrapper	by(java.lang.String name) Get a field by the given name.
FieldStream	filter(boolean isStatic) Filter the fields by whether they are static.
FieldStream	filter(java.lang.Class<?> clazz) Filter the fields by the given type.
FieldStream	filter(java.util.Collection<java.lang.String> names) Filter the fields by the given names.
FieldStream	filter(java.util.function.Predicate<FieldWrapper> filter) Filter the fields with the given filter.
FieldStream	filter(java.lang.String... names) Filter the fields by the given names.
FieldStream	filterAnnotation(java.lang.Class<?> annotation) Filter the fields by whether they have the given annotation.
FieldStream	forEach(java.util.function.Consumer<FieldWrapper> consumer) Loop through all fields in this stream.
java.util.Iterator<FieldWrapper>	iterator()
java.util.stream.Stream<FieldWrapper>	jstream()
<T> java.util.stream.Stream<T>	map(java.util.function.Function<FieldWrapper,T> mapFunction) Map the fields to a new stream.
java.util.Optional<FieldWrapper>	opt(int index) Get a field by the given index.
java.util.Optional<FieldWrapper>	opt(java.lang.String name) Get a field by the given name.
RStream	parent()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldStream

public FieldStream(RStream parent,
                   boolean withSuper)

Method Detail

parent

public RStream parent()

Returns:

The parent stream

size

public int size()

Returns:

The amount of fields in this stream

opt

public java.util.Optional<FieldWrapper> opt(java.lang.String name)

Get a field by the given name.
If there are multiple fields with the same name the first one will be returned.

Parameters:

name - The name of the field

Returns:

The field wrapper

opt

public java.util.Optional<FieldWrapper> opt(int index)

Get a field by the given index.
The index is the position of the field in the stream.

Parameters:

index - The index of the field

Returns:

The field wrapper

by

public FieldWrapper by(java.lang.String name)

Get a field by the given name.
If there are multiple fields with the same name the first one will be returned.

Parameters:

name - The name of the field

Returns:

The field wrapper

Throws:

FieldNotFoundException - If the field doesn't exist

by

public FieldWrapper by(int index)

Get a field by the given index.
The index is the position of the field in the stream.

Parameters:

index - The index of the field

Returns:

The field wrapper

Throws:

FieldNotFoundException - If the field doesn't exist

filter

public FieldStream filter(java.util.function.Predicate<FieldWrapper> filter)

Filter the fields with the given filter.
The current stream will be modified.

Parameters:

filter - The filter

Returns:

This stream

filter

public FieldStream filter(java.util.Collection<java.lang.String> names)

Filter the fields by the given names.
The current stream will be modified.

Parameters:

names - The names of the fields

Returns:

This stream

filter

public FieldStream filter(java.lang.String... names)

Filter the fields by the given names.
The current stream will be modified.

Parameters:

names - The names of the fields

Returns:

This stream

filter

public FieldStream filter(java.lang.Class<?> clazz)

Filter the fields by the given type.
The current stream will be modified.

Parameters:

clazz - The type

Returns:

This stream

filter

public FieldStream filter(boolean isStatic)

Filter the fields by whether they are static.
The current stream will be modified.

Parameters:

isStatic - Whether the fields should be static

Returns:

This stream

filterAnnotation

public FieldStream filterAnnotation(java.lang.Class<?> annotation)

Filter the fields by whether they have the given annotation.
The current stream will be modified.

Parameters:

annotation - The annotation

Returns:

This stream

iterator

public java.util.Iterator<FieldWrapper> iterator()

Returns:

An iterator of field wrappers

map

public <T> java.util.stream.Stream<T> map(java.util.function.Function<FieldWrapper,T> mapFunction)

Map the fields to a new stream.
This is the same as calling jstream() and then Stream.map(Function).

Type Parameters:

T - The type of the new stream

Parameters:

mapFunction - The map function

Returns:

The new stream

jstream

public java.util.stream.Stream<FieldWrapper> jstream()

Returns:

A stream of field wrappers

forEach

public FieldStream forEach(java.util.function.Consumer<FieldWrapper> consumer)

Loop through all fields in this stream.

Parameters:

consumer - The consumer

Returns:

This stream