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

Class TitlesFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<TitlesFlag.TitlesFlagValue,TitlesFlag>

com.plotsquared.core.plot.flag.implementations.TitlesFlag

public class TitlesFlag
extends PlotFlag<TitlesFlag.TitlesFlagValue,TitlesFlag>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TitlesFlag.TitlesFlagValue

Field Summary

Fields

Modifier and Type	Field	Description
static TitlesFlag	TITLES_FALSE
static TitlesFlag	TITLES_NONE
static TitlesFlag	TITLES_TRUE

Method Summary

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

TITLES_NONE

public static final TitlesFlag TITLES_NONE

TITLES_TRUE

public static final TitlesFlag TITLES_TRUE

TITLES_FALSE

public static final TitlesFlag TITLES_FALSE

Method Details

parse

public TitlesFlag 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<TitlesFlag.TitlesFlagValue,TitlesFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

Throws:

FlagParseException - If the value could not be parsed.

merge

public TitlesFlag merge(@NonNull TitlesFlag.TitlesFlagValue 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<TitlesFlag.TitlesFlagValue,TitlesFlag>

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<TitlesFlag.TitlesFlagValue,TitlesFlag>

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<TitlesFlag.TitlesFlagValue,TitlesFlag>

Returns:

An example flag value.

flagOf

protected TitlesFlag flagOf(@NonNull TitlesFlag.TitlesFlagValue value)

Specified by:

flagOf in class PlotFlag<TitlesFlag.TitlesFlagValue,TitlesFlag>

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<TitlesFlag.TitlesFlagValue,TitlesFlag>

Returns:

Collection containing tab completable flag values