Package org.hildan.hashcode.utils.parser.readers.container

Class ContainerReader<E,C,P>

java.lang.Object

org.hildan.hashcode.utils.parser.readers.container.ContainerReader<E,C,P>

Type Parameters:

E - the type of the elements in the container

C - the type of the container itself

P - the type of parent on which this ContainerReader sets the created container

All Implemented Interfaces:

ChildReader<C,P>

public class ContainerReader<E,C,P>
extends java.lang.Object
implements ChildReader<C,P>

An ChildReader that creates a container, and reads multiple child objects from the input, adding them to the container.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContainerReader(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize, ChildReader<? extends E,? super P> itemReader, java.util.function.IntFunction<? extends C> constructor, AddFunction<? super E,? super C> addFunction)	Creates a new ContainerReader that may read the expected number of items from the parent object or a context variable using the provided size getter function.

Method Summary

Modifier and Type	Method	Description
static <E,C,P> ChildReader<C,P>	of(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize, ChildReader<? extends E,? super P> itemReader, java.util.function.IntFunction<? extends C> constructor, AddFunction<? super E,? super C> addFunction)	Creates a new ContainerReader that may read the expected number of items from the parent object or a context variable.
static <E,P> ChildReader<E[],P>	ofArray(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize, ChildReader<? extends E,? super P> itemReader, java.util.function.IntFunction<E[]> arrayCreator)	Creates a ContainerReader that reads an array of items.
static <E,C extends java.util.Collection<E>,P> ChildReader<C,P>	ofCollection(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize, ChildReader<? extends E,? super P> itemReader, java.util.function.IntFunction<C> constructor)	Creates a ContainerReader that reads a collection of items.
static <E,P> ChildReader<java.util.List<E>,P>	ofList(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize, ChildReader<? extends E,? super P> itemReader)	Creates a ContainerReader that reads a list of items.
C	read(@NotNull Context context, P parent)	Reads an object from the given Context, consuming as much input as necessary.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerReader

protected ContainerReader(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize,
                          ChildReader<? extends E,? super P> itemReader,
                          java.util.function.IntFunction<? extends C> constructor,
                          AddFunction<? super E,? super C> addFunction)

Creates a new ContainerReader that may read the expected number of items from the parent object or a context variable using the provided size getter function.

Parameters:

getSize - a function to get the number of items to read, which is given the parent object and context as parameter. Note that the given parent parameter may be null if this reader is called to create a root object.

itemReader - a child reader used to read each item

constructor - a constructor to create a new container, given the size as input

addFunction - a function to add elements to the created container

Method Detail

read

public C read(@NotNull
              @NotNull Context context,
              @Nullable
              P parent)
       throws InputParsingException

Description copied from interface: ChildReader

Reads an object from the given Context, consuming as much input as necessary.

Specified by:

read in interface ChildReader<E,C>

Parameters:

context - the context to read lines from

parent - the parent object within which the object is being created

Returns:

the created object, may be null

Throws:

InputParsingException - if something went wrong when reading the input

of

public static <E,C,P> ChildReader<C,P> of(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize,
                                          ChildReader<? extends E,? super P> itemReader,
                                          java.util.function.IntFunction<? extends C> constructor,
                                          AddFunction<? super E,? super C> addFunction)

Creates a new ContainerReader that may read the expected number of items from the parent object or a context variable.

Type Parameters:

E - the type of the elements in the container

C - the type of the container itself

P - the type of parent on which the created ContainerReader will set the created containers

Parameters:

getSize - a function to get the number of items to read, which is given the parent object and context as parameter. Note that the given parent parameter may be null if this reader is called to create a root object.

itemReader - a child reader used to read each item

constructor - a constructor to create a new container, given the size as input

addFunction - a function to add elements to the created container

Returns:

the created ContainerReader

ofArray

public static <E,P> ChildReader<E[],P> ofArray(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize,
                                               ChildReader<? extends E,? super P> itemReader,
                                               java.util.function.IntFunction<E[]> arrayCreator)

Creates a ContainerReader that reads an array of items.

Type Parameters:

E - the type of elements in the array

P - the type of parent that the created array will be part of

Parameters:

getSize - a function to get the number of items to read, which is given the parent object and context as parameter. Note that the given parent parameter may be null if this reader is called to create a root object.

itemReader - a reader to call as many times as the size returned by getSize. This is what actually consumes input in the created reader.

arrayCreator - a function to create a new array, given its size

Returns:

the created ContainerReader

ofList

public static <E,P> ChildReader<java.util.List<E>,P> ofList(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize,
                                                            ChildReader<? extends E,? super P> itemReader)

Creates a ContainerReader that reads a list of items.

Type Parameters:

E - the type of elements in the list

P - the type of parent that the created list will be part of

Parameters:

getSize - a function to get the number of items to read, which is given the parent object and context as parameter. Note that the given parent parameter may be null if this reader is called to create a root object.

itemReader - a reader to call as many times as the size returned by getSize. This is what actually consumes input in the created reader.

Returns:

the created ContainerReader

ofCollection

public static <E,C extends java.util.Collection<E>,P> ChildReader<C,P> ofCollection(java.util.function.BiFunction<? super P,Context,java.lang.Integer> getSize,
                                                                                    ChildReader<? extends E,? super P> itemReader,
                                                                                    java.util.function.IntFunction<C> constructor)

Creates a ContainerReader that reads a collection of items.

Type Parameters:

E - the type of elements in the collection

C - the type of collections to create

P - the type of parent that the created collection will be part of

Parameters:

getSize - a function to get the number of items to read, which is given the parent object and context as parameter. Note that the given parent parameter may be null if this reader is called to create a root object.

itemReader - a reader to call as many times as the size returned by getSize. This is what actually consumes input in the created reader.

constructor - a function to create a new collection, given its size

Returns:

the created ContainerReader