Package com.plotsquared.core.plot.flag.types

Class IntegerFlag<F extends NumberFlag<Integer,F>>

java.lang.Object

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

com.plotsquared.core.plot.flag.types.NumberFlag<Integer,F>

com.plotsquared.core.plot.flag.types.IntegerFlag<F>

Direct Known Subclasses:

NonNegativeIntegerFlag

public abstract class IntegerFlag<F extends NumberFlag<Integer,F>>
extends NumberFlag<Integer,F>

Field Summary

Fields inherited from class com.plotsquared.core.plot.flag.types.NumberFlag

maximum, minimum

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IntegerFlag(int value, int minimum, int maximum, @NonNull Caption flagDescription)
protected	IntegerFlag(@NonNull Caption flagDescription)

Method Summary

Modifier and Type	Method	Description
String	getExample()	An example of a string that would parse into a valid flag value.
F	merge(@NonNull Integer newValue)	Merge this flag's value with another value and return an instance holding the merged value.
protected @NonNull Integer	parseNumber(String input)	Parse the raw string input to the number type.
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.NumberFlag

parse

Methods inherited from class com.plotsquared.core.plot.flag.PlotFlag

canEqual, createFlagInstance, equals, flagOf, getFlagCategory, getFlagDescription, getFlagName, getName, getTabCompletions, getValue, hashCode, isValuedPermission

Methods inherited from class java.lang.Object

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

Constructor Details

IntegerFlag

protected IntegerFlag(int value,
 int minimum,
 int maximum,
 @NonNull Caption flagDescription)

IntegerFlag

protected IntegerFlag(@NonNull Caption flagDescription)

Method Details

merge

public F merge(@NonNull Integer 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<Integer,F extends NumberFlag<Integer,F>>

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<Integer,F extends NumberFlag<Integer,F>>

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<Integer,F extends NumberFlag<Integer,F>>

Returns:

An example flag value.

parseNumber

protected @NonNull Integer parseNumber(String input)
                                throws FlagParseException

Description copied from class: NumberFlag

Parse the raw string input to the number type.

Specified by:

parseNumber in class NumberFlag<Integer,F extends NumberFlag<Integer,F>>

Parameters:

input - the string to parse the number from.

Returns:

the parsed number.

Throws:

FlagParseException - if the number couldn't be parsed.