ru.noties.requirements

Class Requirement

java.lang.Object

ru.noties.requirements.Requirement

public abstract class Requirement
extends java.lang.Object

See Also:

RequirementBuilder, RequirementBuilder.create(EventDispatcher, EventSource)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Requirement.Listener Listener to be notified about requirement resolution process

Constructor Summary

Constructors

Constructor and Description
Requirement()

Method Summary

Modifier and Type	Method and Description
abstract void	cancel() A method to cancel requirement resolution process.
abstract void	cancel(Payload payload) A method to cancel requirement resolution process.
abstract boolean	isInProgress() A method to check if requirement resolution is currently in progress
abstract boolean	isValid() Synchronous method to check if the whole requirement cases chain meets requirement.
abstract void	validate(Requirement.Listener listener) Please note that this method allows multiple listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

Requirement

public Requirement()

Method Detail

validate

public abstract void validate(Requirement.Listener listener)

Please note that this method allows multiple listeners. If resolution process is started and validate was called again, then listener won\'t trigger full validation process, but instead subscribe for the result (when it will be obtained)

Parameters:

listener - Requirement.Listener to be notified about resolution progress

isValid

public abstract boolean isValid()

Synchronous method to check if the whole requirement cases chain meets requirement. Simply returns true or false without triggering requirement resolution

Returns:

a boolean indicating if this requirement is valid (meets requirement)

Since:

1.1.0

cancel

public abstract void cancel()

A method to cancel requirement resolution process. The same as calling cancel(Payload) with null payload

Since:

1.0.1

See Also:

cancel(Payload), isInProgress()

cancel

public abstract void cancel(Payload payload)

A method to cancel requirement resolution process. If there are active listeners, they will receive supplied payload in Requirement.Listener.onRequirementFailure(Payload)

Parameters:

payload - Payload to pass to active listeners of resolution process

Since:

1.0.1

isInProgress

public abstract boolean isInProgress()

A method to check if requirement resolution is currently in progress

Returns:

a boolean indicating if requirement resolution is in progress

Since:

1.0.1