Package com.pixelmonmod.api.requirement

Class AbstractRecursiveRequirement<A,B>

java.lang.Object

com.pixelmonmod.api.requirement.AbstractRecursiveRequirement<A,B>

All Implemented Interfaces:

Requirement<A,B,List<Requirement<A,B,?>>>

public abstract class AbstractRecursiveRequirement<A,B>
extends Object
implements Requirement<A,B,List<Requirement<A,B,?>>>

The basics for a recursive requirement

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Requirement<A,B,?>>	requirements

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRecursiveRequirement(Class<? extends Specification<A,B>> clazz, Set<String> keys)
protected	AbstractRecursiveRequirement(Class<? extends Specification<A,B>> clazz, Set<String> keys, List<Requirement<A,B,?>> requirements)

Method Summary

Modifier and Type	Method	Description
ParseAttempt<List<Requirement<A,B,?>>>	create(String spec)	Creates a list of requirements from the spec being parsed
boolean	fits(String spec)	Checks if the given fits for this requirement
List<String>	getAliases()	The aliases of the requirement that it can match against
int	getPriority()	Gets the order priority of the requirement.
List<Requirement<A,B,?>>	getValue()	Gets the internal value of the requirement
boolean	shouldContinue()	If the spec should continue processing the results after applying this requirement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pixelmonmod.api.requirement.Requirement

applyData, applyMinecraft, createInstance, isDataMatch, isMinecraftMatch

Field Details

requirements

protected List<Requirement<A,B,?>> requirements

Constructor Details

AbstractRecursiveRequirement

protected AbstractRecursiveRequirement(Class<? extends Specification<A,B>> clazz,
 Set<String> keys)

AbstractRecursiveRequirement

protected AbstractRecursiveRequirement(Class<? extends Specification<A,B>> clazz,
 Set<String> keys,
 List<Requirement<A,B,?>> requirements)

Method Details

getAliases

public List<String> getAliases()

Description copied from interface: Requirement

The aliases of the requirement that it can match against

Specified by:

getAliases in interface Requirement<A,B,List<Requirement<A,B,?>>>

Returns:

The aliases

getPriority

public int getPriority()

Description copied from interface: Requirement

Gets the order priority of the requirement. Higher number = higher priority (i.e. it is applied first)

Specified by:

getPriority in interface Requirement<A,B,List<Requirement<A,B,?>>>

Returns:

The priority

shouldContinue

public boolean shouldContinue()

Description copied from interface: Requirement

If the spec should continue processing the results after applying this requirement.
For example, for a logical AND this would return false as it handles the processing of the remaining requirements

Specified by:

shouldContinue in interface Requirement<A,B,List<Requirement<A,B,?>>>

Returns:

True if it should continue processing

fits

public boolean fits(String spec)

Description copied from interface: Requirement

Checks if the given fits for this requirement

Specified by:

fits in interface Requirement<A,B,List<Requirement<A,B,?>>>

Parameters:

spec - The parsed spec

Returns:

True if this requirement is found in the parameter

create

public ParseAttempt<List<Requirement<A,B,?>>> create(String spec)

Description copied from interface: Requirement

Creates a list of requirements from the spec being parsed

Specified by:

create in interface Requirement<A,B,List<Requirement<A,B,?>>>

Parameters:

spec - The spec being parsed

Returns:

The new list of requirements

getValue

public List<Requirement<A,B,?>> getValue()

Description copied from interface: Requirement

Gets the internal value of the requirement

Specified by:

getValue in interface Requirement<A,B,List<Requirement<A,B,?>>>

Returns:

The value stored