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

Class DescriptionFlag

java.lang.Object

com.plotsquared.core.plot.flag.PlotFlag<String,F>

com.plotsquared.core.plot.flag.types.StringFlag<DescriptionFlag>

com.plotsquared.core.plot.flag.implementations.DescriptionFlag

public class DescriptionFlag
extends StringFlag<DescriptionFlag>

Field Summary

Fields

Modifier and Type	Field	Description
static final DescriptionFlag	DESCRIPTION_FLAG_EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DescriptionFlag(@NonNull String value)

Method Summary

Modifier and Type	Method	Description
protected DescriptionFlag	flagOf(@NonNull String value)
String	getExample()	An example of a string that would parse into a valid flag value.
DescriptionFlag	merge(@NonNull String newValue)	Merge this flag's value with another value and return an instance holding the merged value.
DescriptionFlag	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.types.StringFlag

isValuedPermission

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

DESCRIPTION_FLAG_EMPTY

public static final DescriptionFlag DESCRIPTION_FLAG_EMPTY

Constructor Details

DescriptionFlag

protected DescriptionFlag(@NonNull String value)

Method Details

parse

public DescriptionFlag parse(@NonNull String input)

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<String,DescriptionFlag>

Parameters:

input - String to parse.

Returns:

Parsed value, if valid.

merge

public DescriptionFlag merge(@NonNull String 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<String,DescriptionFlag>

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<String,DescriptionFlag>

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<String,DescriptionFlag>

Returns:

An example flag value.

flagOf

protected DescriptionFlag flagOf(@NonNull String value)

Specified by:

flagOf in class PlotFlag<String,DescriptionFlag>