Package com.plotsquared.core.plot.flag.implementations

Class LiquidFlowFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

com.plotsquared.core.plot.flag.implementations.LiquidFlowFlag

public class LiquidFlowFlag
extends PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LiquidFlowFlag.FlowStatus

Field Summary

Fields

Modifier and Type	Field	Description
static LiquidFlowFlag	LIQUID_FLOW_DEFAULT
static LiquidFlowFlag	LIQUID_FLOW_DISABLED
static LiquidFlowFlag	LIQUID_FLOW_ENABLED

Method Summary

Modifier and Type	Method	Description
protected LiquidFlowFlag	flagOf(@NonNull LiquidFlowFlag.FlowStatus value)
String	getExample()	An example of a string that would parse into a valid flag value.
Collection<String>	getTabCompletions()	Get the tab completable values associated with the flag type, or an empty collection if tab completion isn't supported.
LiquidFlowFlag	merge(@NonNull LiquidFlowFlag.FlowStatus newValue)	Merge this flag's value with another value and return an instance holding the merged value.
LiquidFlowFlag	parse(@NonNull String input)	Parse a string into a flag, and throw an exception in the case that the string does not represent a valid flag value.
String	toString()	Returns a string representation of the flag instance, that when passed through PlotFlag.parse(String) will result in an equivalent instance of the flag.

Methods inherited from class com.plotsquared.core.plot.flag.PlotFlag

canEqual, createFlagInstance, equals, getFlagCategory, getFlagDescription, getFlagName, getName, getValue, hashCode, isValuedPermission

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LIQUID_FLOW_ENABLED

public static final LiquidFlowFlag LIQUID_FLOW_ENABLED

LIQUID_FLOW_DISABLED

public static final LiquidFlowFlag LIQUID_FLOW_DISABLED

LIQUID_FLOW_DEFAULT

public static final LiquidFlowFlag LIQUID_FLOW_DEFAULT

Method Details

parse

public LiquidFlowFlag parse(@NonNull String input)

Description copied from class: PlotFlag

Parse a string into a flag, and throw an exception in the case that the string does not represent a valid flag value. This instance won't change its state, but instead an instance holding the parsed flag value will be returned.

Specified by:

parse in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

merge

public LiquidFlowFlag merge(@NonNull LiquidFlowFlag.FlowStatus newValue)

Description copied from class: PlotFlag

Merge this flag's value with another value and return an instance holding the merged value.

Specified by:

merge in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Parameters:

newValue - New flag value.

Returns:

Flag containing parsed flag value.

toString

public String toString()

Description copied from class: PlotFlag

Returns a string representation of the flag instance, that when passed through PlotFlag.parse(String) will result in an equivalent instance of the flag.

Specified by:

toString in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Returns:

String representation of the flag

getExample

public String getExample()

Description copied from class: PlotFlag

An example of a string that would parse into a valid flag value.

Specified by:

getExample in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Returns:

An example flag value.

flagOf

protected LiquidFlowFlag flagOf(@NonNull LiquidFlowFlag.FlowStatus value)

Specified by:

flagOf in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

getTabCompletions

public Collection<String> getTabCompletions()

Description copied from class: PlotFlag

Get the tab completable values associated with the flag type, or an empty collection if tab completion isn't supported.

Overrides:

getTabCompletions in class PlotFlag<LiquidFlowFlag.FlowStatus,LiquidFlowFlag>

Returns:

Collection containing tab completable flag values