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

Class GamemodeFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<GameMode,GamemodeFlag>

com.plotsquared.core.plot.flag.implementations.GamemodeFlag

public class GamemodeFlag
extends PlotFlag<GameMode,GamemodeFlag>

Field Summary

Fields

Modifier and Type	Field	Description
static final GameMode	DEFAULT
static final GamemodeFlag	GAMEMODE_FLAG_ADVENTURE
static final GamemodeFlag	GAMEMODE_FLAG_CREATIVE
static final GamemodeFlag	GAMEMODE_FLAG_DEFAULT
static final GamemodeFlag	GAMEMODE_FLAG_SPECTATOR
static final GamemodeFlag	GAMEMODE_FLAG_SURVIVAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GamemodeFlag(@NonNull GameMode value)	Construct a new flag instance.

Method Summary

Modifier and Type	Method	Description
protected GamemodeFlag	flagOf(@NonNull GameMode 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.
GamemodeFlag	merge(@NonNull GameMode newValue)	Merge this flag's value with another value and return an instance holding the merged value.
GamemodeFlag	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

DEFAULT

public static final GameMode DEFAULT

GAMEMODE_FLAG_CREATIVE

public static final GamemodeFlag GAMEMODE_FLAG_CREATIVE

GAMEMODE_FLAG_ADVENTURE

public static final GamemodeFlag GAMEMODE_FLAG_ADVENTURE

GAMEMODE_FLAG_SPECTATOR

public static final GamemodeFlag GAMEMODE_FLAG_SPECTATOR

GAMEMODE_FLAG_SURVIVAL

public static final GamemodeFlag GAMEMODE_FLAG_SURVIVAL

GAMEMODE_FLAG_DEFAULT

public static final GamemodeFlag GAMEMODE_FLAG_DEFAULT

Constructor Details

GamemodeFlag

protected GamemodeFlag(@NonNull GameMode value)

Construct a new flag instance.

Parameters:

value - Flag value

Method Details

parse

public GamemodeFlag 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<GameMode,GamemodeFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

Throws:

FlagParseException - If the value could not be parsed.

merge

public GamemodeFlag merge(@NonNull GameMode 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<GameMode,GamemodeFlag>

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<GameMode,GamemodeFlag>

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<GameMode,GamemodeFlag>

Returns:

An example flag value.

flagOf

protected GamemodeFlag flagOf(@NonNull GameMode value)

Specified by:

flagOf in class PlotFlag<GameMode,GamemodeFlag>

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<GameMode,GamemodeFlag>

Returns:

Collection containing tab completable flag values