Class PlotTitleFlag
java.lang.Object
com.plotsquared.core.plot.flag.PlotFlag<PlotTitle,PlotTitleFlag>
com.plotsquared.core.plot.flag.implementations.PlotTitleFlag
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPlotTitleFlag(PlotTitle value) Construct a new flag instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected PlotTitleFlagAn example of a string that would parse into a valid flag value.booleanGet if the flag's permission should check for values.Merge this flag's value with another value and return an instance holding the merged value.Parse a string into a flag, and throw an exception in the case that the string does not represent a valid flag value.toString()Returns a string representation of the flag instance, that when passed throughPlotFlag.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
-
Field Details
-
TITLE_FLAG_DEFAULT
-
-
Constructor Details
-
PlotTitleFlag
Construct a new flag instance.- Parameters:
value- Flag value
-
-
Method Details
-
parse
Description copied from class:PlotFlagParse 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:
parsein classPlotFlag<PlotTitle,PlotTitleFlag> - Parameters:
input- String to parse.- Returns:
- Parsed value, if valid.
- Throws:
FlagParseException- If the value could not be parsed.
-
merge
Description copied from class:PlotFlagMerge this flag's value with another value and return an instance holding the merged value.- Specified by:
mergein classPlotFlag<PlotTitle,PlotTitleFlag> - Parameters:
newValue- New flag value.- Returns:
- Flag containing parsed flag value.
-
toString
Description copied from class:PlotFlagReturns a string representation of the flag instance, that when passed throughPlotFlag.parse(String)will result in an equivalent instance of the flag.- Specified by:
toStringin classPlotFlag<PlotTitle,PlotTitleFlag> - Returns:
- String representation of the flag
-
isValuedPermission
public boolean isValuedPermission()Description copied from class:PlotFlagGet if the flag's permission should check for values. E.g. plots.flag.set.music.VALUE- Overrides:
isValuedPermissionin classPlotFlag<PlotTitle,PlotTitleFlag> - Returns:
- if valued permission
-
getExample
Description copied from class:PlotFlagAn example of a string that would parse into a valid flag value.- Specified by:
getExamplein classPlotFlag<PlotTitle,PlotTitleFlag> - Returns:
- An example flag value.
-
flagOf
- Specified by:
flagOfin classPlotFlag<PlotTitle,PlotTitleFlag>
-