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

Class DenyTeleportFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

com.plotsquared.core.plot.flag.implementations.DenyTeleportFlag

public class DenyTeleportFlag
extends PlotFlag<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DenyTeleportFlag.DeniedGroup

Field Summary

Fields

Modifier and Type	Field	Description
static DenyTeleportFlag	DENY_TELEPORT_FLAG_NONE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DenyTeleportFlag(@NonNull DenyTeleportFlag.DeniedGroup value)	Construct a new flag instance.

Method Summary

Modifier and Type	Method	Description
static boolean	allowsTeleport(PlotPlayer<?> player, Plot plot)
protected DenyTeleportFlag	flagOf(@NonNull DenyTeleportFlag.DeniedGroup 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.
DenyTeleportFlag	merge(@NonNull DenyTeleportFlag.DeniedGroup newValue)	Merge this flag's value with another value and return an instance holding the merged value.
DenyTeleportFlag	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

DENY_TELEPORT_FLAG_NONE

public static final DenyTeleportFlag DENY_TELEPORT_FLAG_NONE

Constructor Details

DenyTeleportFlag

protected DenyTeleportFlag(@NonNull DenyTeleportFlag.DeniedGroup value)

Construct a new flag instance.

Parameters:

value - Flag value

Method Details

allowsTeleport

public static boolean allowsTeleport(PlotPlayer<?> player,
 Plot plot)

parse

public DenyTeleportFlag 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<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

Throws:

FlagParseException - If the value could not be parsed.

merge

public DenyTeleportFlag merge(@NonNull DenyTeleportFlag.DeniedGroup 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<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

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<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

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<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

Returns:

An example flag value.

flagOf

protected DenyTeleportFlag flagOf(@NonNull DenyTeleportFlag.DeniedGroup value)

Specified by:

flagOf in class PlotFlag<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

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<DenyTeleportFlag.DeniedGroup,DenyTeleportFlag>

Returns:

Collection containing tab completable flag values