Package com.plotsquared.core.plot.flag.types

Class BlockTypeListFlag<F extends ListFlag<BlockTypeWrapper,F>>

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<List<V>,F>

com.plotsquared.core.plot.flag.types.ListFlag<BlockTypeWrapper,F>

com.plotsquared.core.plot.flag.types.BlockTypeListFlag<F>

Direct Known Subclasses:

BreakFlag, PlaceFlag, UseFlag

public abstract class BlockTypeListFlag<F extends ListFlag<BlockTypeWrapper,F>>
extends ListFlag<BlockTypeWrapper,F>

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	skipCategoryVerification

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BlockTypeListFlag(List<BlockTypeWrapper> blockTypeList, Caption description)

Method Summary

Modifier and Type	Method	Description
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.
F	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.

Methods inherited from class com.plotsquared.core.plot.flag.types.ListFlag

merge, toString

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

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

Methods inherited from class java.lang.Object

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

Field Details

skipCategoryVerification

public static boolean skipCategoryVerification

Constructor Details

BlockTypeListFlag

protected BlockTypeListFlag(List<BlockTypeWrapper> blockTypeList,
 Caption description)

Method Details

parse

public F parse(@NonNull String input)
        throws FlagParseException

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<List<BlockTypeWrapper>,F extends ListFlag<BlockTypeWrapper,F>>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

Throws:

FlagParseException - If the value could not be parsed.

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<List<BlockTypeWrapper>,F extends ListFlag<BlockTypeWrapper,F>>

Returns:

An example flag value.

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<List<BlockTypeWrapper>,F extends ListFlag<BlockTypeWrapper,F>>

Returns:

Collection containing tab completable flag values