ru.noties.requirements

Class RequirementBuilder<T>

java.lang.Object

ru.noties.requirements.RequirementBuilder<T>

public abstract class RequirementBuilder<T>
extends java.lang.Object

Builder class to create a Requirement.

Please note that one instance of this builder can be built exactly once.

Changed in 1.1.0: added type argument

Constructor Summary

Constructors

Constructor and Description
RequirementBuilder()

Method Summary

Modifier and Type	Method and Description
abstract RequirementBuilder<T>	add(RequirementCase<? super T> requirementCase) Adds a RequirementCase to this builder
abstract RequirementBuilder<T>	addAll(java.util.Collection<? extends RequirementCase<? super T>> requirementCases) Adds a collection of RequirementCase to this builder.
abstract RequirementBuilder<T>	addAllIf(boolean result, java.util.Collection<? extends RequirementCase<? super T>> requirementCases) Adds a collection of RequirementCase to this builder.
abstract RequirementBuilder<T>	addIf(boolean result, RequirementCase<? super T> requirementCase) Adds a RequirementCase to this builder only if `result` is true
abstract Requirement	build() Please note that if no RequirementCase were added, then build Requirement will always be in `success` state
static <T> RequirementBuilder<T>	create(EventDispatcher<T> eventDispatcher, EventSource eventSource) Factory method to obtain an instance of RequirementBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

RequirementBuilder

public RequirementBuilder()

Method Detail

create

public static <T> RequirementBuilder<T> create(EventDispatcher<T> eventDispatcher,
                                               EventSource eventSource)

Factory method to obtain an instance of RequirementBuilder

Returns:

new instance of RequirementBuilder

See Also:

EventDispatcher, EventSource

add

public abstract RequirementBuilder<T> add(RequirementCase<? super T> requirementCase)
                                   throws java.lang.IllegalStateException

Adds a RequirementCase to this builder

Parameters:

requirementCase - RequirementCase to add

Returns:

this instance for chaining

Throws:

java.lang.IllegalStateException - if this builder instance had been built already

addIf

public abstract RequirementBuilder<T> addIf(boolean result,
                                            RequirementCase<? super T> requirementCase)
                                     throws java.lang.IllegalStateException

Adds a RequirementCase to this builder only if `result` is true

Parameters:

result - boolean to check if RequirementCase should be added

requirementCase - RequirementCase to add if `result` is true

Returns:

this instance for chaining

Throws:

java.lang.IllegalStateException - if this builder instance had been built already

addAll

public abstract RequirementBuilder<T> addAll(java.util.Collection<? extends RequirementCase<? super T>> requirementCases)
                                      throws java.lang.IllegalStateException

Adds a collection of RequirementCase to this builder. Please note that collection must not contain `null` as elements

Parameters:

requirementCases - collection of RequirementCase to add

Returns:

this instance for chaining

Throws:

java.lang.IllegalStateException - if this builder instance had been built already

addAllIf

public abstract RequirementBuilder<T> addAllIf(boolean result,
                                               java.util.Collection<? extends RequirementCase<? super T>> requirementCases)
                                        throws java.lang.IllegalStateException

Adds a collection of RequirementCase to this builder. Please note that collection must not contain `null` as elements only if `result` is true

Parameters:

result - boolean to check if collection of RequirementCase should be added

requirementCases - collection of RequirementCase to add if `result` is true

Returns:

this instance for chaining

Throws:

java.lang.IllegalStateException - if this builder instance had been built already

build

public abstract Requirement build()
                           throws java.lang.IllegalStateException

Please note that if no RequirementCase were added, then build Requirement will always be in `success` state

Returns:

Requirement

Throws:

java.lang.IllegalStateException - if this builder instance had been built already

See Also:

EventSource