Package org.skriptlang.skript.lang.experiment

Class ExperimentData

java.lang.Object

org.skriptlang.skript.lang.experiment.ExperimentData

public class ExperimentData
extends Object

Container for holding Experiments that must be enabled or disabled to use.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExperimentData.Builder

Method Summary

Modifier and Type	Method	Description
static ExperimentData.Builder	builder()	Create and return a new ExperimentData.Builder.
boolean	checkRequirements(ExperimentSet experiments)	Check if the requirements of this ExperimentData are met.
boolean	checkRequirementsAndError(ExperimentSet experiments)	Check if the requirements of this ExperimentData are met.
String	constructError()	Construct a String combining what Experiments need to be enabled and/or disabled in order to use.
static ExperimentData	createSingularData(Experiment experiment)	Create a new ExperimentData with only a singular required Experiment
@Unmodifiable Set<Experiment>	getDisallowed()	Get the Experiments that must be disabled in order to use.
String	getErrorMessage()	Get the String used to error when checkRequirementsAndError(ExperimentSet) fails.
@Unmodifiable Set<Experiment>	getRequired()	Get the Experiments that must be enabled in order to use.
ExperimentData.Builder	toBuilder()	Get a ExperimentData.Builder with the current data of this ExperimentData.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ExperimentData.Builder builder()

Create and return a new ExperimentData.Builder.

createSingularData

public static ExperimentData createSingularData(Experiment experiment)

Create a new ExperimentData with only a singular required Experiment

Parameters:

experiment - The required Experiment.

Returns:

ExperimentData

getRequired

public @Unmodifiable Set<Experiment> getRequired()

Get the Experiments that must be enabled in order to use.

getDisallowed

public @Unmodifiable Set<Experiment> getDisallowed()

Get the Experiments that must be disabled in order to use.

getErrorMessage

public String getErrorMessage()

Get the String used to error when checkRequirementsAndError(ExperimentSet) fails. If the errorMessage was not manually set when building ExperimentData.Builder, uses the message from constructError().

checkRequirements

public boolean checkRequirements(ExperimentSet experiments)

Check if the requirements of this ExperimentData are met.

Parameters:

experiments - The current enabled Experiments.

Returns:

True if the requirements were met.

checkRequirementsAndError

public boolean checkRequirementsAndError(ExperimentSet experiments)

Check if the requirements of this ExperimentData are met. If the requirements are not met, will produce a Skript.error(String) using errorMessage.

Parameters:

experiments - The current enabled Experiments.

Returns:

True if the requirements were met.

constructError

public String constructError()

Construct a String combining what Experiments need to be enabled and/or disabled in order to use.

toBuilder

public ExperimentData.Builder toBuilder()

Get a ExperimentData.Builder with the current data of this ExperimentData.