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

Class PlotTitleFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<PlotTitle,PlotTitleFlag>

com.plotsquared.core.plot.flag.implementations.PlotTitleFlag

public class PlotTitleFlag
extends PlotFlag<PlotTitle,PlotTitleFlag>

Field Summary

Fields

Modifier and Type	Field	Description
static final PlotTitleFlag	TITLE_FLAG_DEFAULT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlotTitleFlag(PlotTitle value)	Construct a new flag instance.

Method Summary

Modifier and Type	Method	Description
protected PlotTitleFlag	flagOf(@NonNull PlotTitle value)
String	getExample()	An example of a string that would parse into a valid flag value.
boolean	isValuedPermission()	Get if the flag's permission should check for values.
PlotTitleFlag	merge(@NonNull PlotTitle newValue)	Merge this flag's value with another value and return an instance holding the merged value.
PlotTitleFlag	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, getTabCompletions, getValue, hashCode

Methods inherited from class java.lang.Object

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

Field Details

TITLE_FLAG_DEFAULT

public static final PlotTitleFlag TITLE_FLAG_DEFAULT

Constructor Details

PlotTitleFlag

protected PlotTitleFlag(PlotTitle value)

Construct a new flag instance.

Parameters:

value - Flag value

Method Details

parse

public PlotTitleFlag 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<PlotTitle,PlotTitleFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

Throws:

FlagParseException - If the value could not be parsed.

merge

public PlotTitleFlag merge(@NonNull PlotTitle 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<PlotTitle,PlotTitleFlag>

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<PlotTitle,PlotTitleFlag>

Returns:

String representation of the flag

isValuedPermission

public boolean isValuedPermission()

Description copied from class: PlotFlag

Get if the flag's permission should check for values. E.g. plots.flag.set.music.VALUE

Overrides:

isValuedPermission in class PlotFlag<PlotTitle,PlotTitleFlag>

Returns:

if valued permission

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<PlotTitle,PlotTitleFlag>

Returns:

An example flag value.

flagOf

protected PlotTitleFlag flagOf(@NonNull PlotTitle value)

Specified by:

flagOf in class PlotFlag<PlotTitle,PlotTitleFlag>