com.mantledillusion.data.collo

Class InputGroup.InputGroupBuilder<P extends Enum<P> & InputPart>

java.lang.Object

com.mantledillusion.data.collo.InputGroup.InputGroupBuilder<P>

Type Parameters:

P - The InputPart implementing Enum type that defines the group's parts.

Enclosing class:

InputGroup<P extends Enum<P> & InputPart>

public static final class InputGroup.InputGroupBuilder<P extends Enum<P> & InputPart>
extends Object

A builder for InputGroups.

All InputParts given to the builder will be contained and checked by the finally build group in the exact order they where given to the builder.

Method Summary

Modifier and Type	Method and Description
InputGroup.InputGroupBuilder<P>	andPart(P inputPart) Adds the given InputPart to the InputGroup to build.
InputGroup.InputGroupBuilder<P>	andPart(P inputPart, PartOccurrenceMode partOccurrenceMode) Adds the given InputPart to the InputGroup to build.
InputGroup<P>	build() Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.
InputGroup<P>	build(boolean matchesAny) Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.
InputGroup<P>	build(boolean matchesAny, String spliterator) Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.
InputGroup<P>	build(String spliterator) Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

andPart

public InputGroup.InputGroupBuilder<P> andPart(P inputPart)

Adds the given InputPart to the InputGroup to build.

Parameters:

inputPart - The part to add; might not be null.

Returns:

this

andPart

public InputGroup.InputGroupBuilder<P> andPart(P inputPart,
                                               PartOccurrenceMode partOccurrenceMode)

Adds the given InputPart to the InputGroup to build.

Parameters:

inputPart - The part to add; might not be null.

partOccurrenceMode - The mode describing how the part can occur in its group; might not be null.

Returns:

this

build

public InputGroup<P> build()

Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.

matchesAny will be set to true; Even if all the group's parts are optional, at least one has to match a given term in order for the group to match.

spliterator will be set to " "; the group's parts are expected to be separated by a space.

Returns:

A new InputGroup; never null

build

public InputGroup<P> build(boolean matchesAny)

Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.

spliterator will be set to " "; the group's parts are expected to be separated by a space.

Parameters:

matchesAny - Whether or not any of the group's parts has to match in a given input term. This has only effect in groups whose parts are all optional; in that case, using false will allow an empty String to match the group.

Returns:

A new InputGroup; never null

build

public InputGroup<P> build(String spliterator)

Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.

matchesAny will be set to true; Even if all the group's parts are optional, at least one has to match a given term in order for the group to match.

Parameters:

spliterator - The separator to split an input term by to gain separated InputParts; might not be null.

Returns:

A new InputGroup; never null

build

public InputGroup<P> build(boolean matchesAny,
                           String spliterator)

Builds an InputGroup out of the InputParts currently contained by this InputGroup.InputGroupBuilder.

Parameters:

matchesAny - Whether or not any of the group's parts has to match in a given input term. This has only effect in groups whose parts are all optional; in that case, using false will allow an empty String to match the group.

spliterator - The separator to split an input term by to gain separated

Returns:

A new InputGroup; never null