Package com.djrapitops.plan.extension.implementation.builder

Class ExtValueBuilder

java.lang.Object

com.djrapitops.plan.extension.implementation.builder.ExtValueBuilder

All Implemented Interfaces:

ValueBuilder

public class ExtValueBuilder
extends java.lang.Object
implements ValueBuilder

Constructor Summary

Constructors

Constructor	Description
ExtValueBuilder(java.lang.String text, DataExtension extension)

Method Summary

Modifier and Type	Method	Description
DataValue<java.lang.Boolean>	buildBoolean(boolean value)	Build a Boolean.
DataValue<java.lang.Boolean>	buildBoolean(java.util.function.Supplier<java.lang.Boolean> value)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.Boolean>	buildBooleanProvidingCondition(boolean value, java.lang.String providedCondition)	Build a Boolean that provides a value for Conditional.
DataValue<java.lang.Boolean>	buildBooleanProvidingCondition(java.util.function.Supplier<java.lang.Boolean> value, java.lang.String providedCondition)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.Double>	buildDouble(java.lang.Double value)	Build a Floating point number.
DataValue<java.lang.Double>	buildDouble(java.util.function.Supplier<java.lang.Double> value)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.String[]>	buildGroup(java.lang.String[] groups)	Build a list of groups.
DataValue<java.lang.String[]>	buildGroup(java.util.function.Supplier<java.lang.String[]> groups)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.Long>	buildNumber(java.lang.Long value)	Build a Number.
DataValue<java.lang.Long>	buildNumber(java.util.function.Supplier<java.lang.Long> value)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.Double>	buildPercentage(java.lang.Double value)	Build a Percentage.
DataValue<java.lang.Double>	buildPercentage(java.util.function.Supplier<java.lang.Double> percentage)	Lambda version for conditional return or throwing NotReadyException.
DataValue<java.lang.String>	buildString(java.lang.String value)	Build a String.
DataValue<java.lang.String>	buildString(java.util.function.Supplier<java.lang.String> value)	Lambda version for conditional return or throwing NotReadyException.
DataValue<Table>	buildTable(Table table, Color tableColor)	Build a table.
DataValue<Table>	buildTable(java.util.function.Supplier<Table> table, Color tableColor)	Lambda version for conditional return or throwing NotReadyException.
ValueBuilder	conditional(Conditional conditional)	Implementation detail - for abstracting annotations with the builder API.
ValueBuilder	description(java.lang.String description)	Description about the value that is shown on hover.
ValueBuilder	format(FormatType formatType)	ValueBuilder.buildNumber(Long) specific method, format the value with FormatType
static java.lang.String	formatTextAsIdentifier(java.lang.String text)
ValueBuilder	hideFromUsers(BooleanProvider annotation)	Implementation detail - for abstracting annotations with the builder API.
ValueBuilder	icon(Icon icon)	Icon displayed next to the value.
ValueBuilder	methodName(ExtensionMethod method)	Implementation detail - for abstracting annotations with the builder API.
ValueBuilder	priority(int priority)	Display-priority of the value, highest value is placed top most.
ValueBuilder	showAsPlayerPageLink()	ValueBuilder.buildString(String) specific method, link the value to a player page.
ValueBuilder	showInPlayerTable()	Show this value in the players table.
ValueBuilder	showOnTab(java.lang.String tabName)	Show the value on a specific tab.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.djrapitops.plan.extension.builder.ValueBuilder

buildNumber, buildNumber, formatAsDateWithSeconds, formatAsDateWithYear, formatAsTimeAmount, icon, showAsPlayerPageLink, showInPlayerTable, showOnTab

Constructor Detail

ExtValueBuilder

public ExtValueBuilder(java.lang.String text,
                       DataExtension extension)

Method Detail

formatTextAsIdentifier

public static java.lang.String formatTextAsIdentifier(java.lang.String text)

methodName

public ValueBuilder methodName(ExtensionMethod method)

Description copied from interface: ValueBuilder

Implementation detail - for abstracting annotations with the builder API.

Specified by:

methodName in interface ValueBuilder

Parameters:

method - Method this value is from.

Returns:

This builder.

description

public ValueBuilder description(java.lang.String description)

Description copied from interface: ValueBuilder

Description about the value that is shown on hover.

Specified by:

description in interface ValueBuilder

Parameters:

description - Describe what the value is about, maximum 150 characters.

Returns:

This builder.

priority

public ValueBuilder priority(int priority)

Description copied from interface: ValueBuilder

Display-priority of the value, highest value is placed top most.

Two values with same priority may appear in a random order.

Specified by:

priority in interface ValueBuilder

Parameters:

priority - Priority between 0 and Integer.MAX_VALUE.

Returns:

This builder.

showInPlayerTable

public ValueBuilder showInPlayerTable()

Description copied from interface: ValueBuilder

Show this value in the players table.

Specified by:

showInPlayerTable in interface ValueBuilder

Returns:

This builder.

icon

public ValueBuilder icon(Icon icon)

Description copied from interface: ValueBuilder

Icon displayed next to the value.

See https://fontawesome.com/icons (select 'free')) for icons

Specified by:

icon in interface ValueBuilder

Parameters:

icon - Icon built using the methods in Icon.

Returns:

This builder.

showOnTab

public ValueBuilder showOnTab(java.lang.String tabName)

Description copied from interface: ValueBuilder

Show the value on a specific tab.

Remember to define TabInfo annotation.

Specified by:

showOnTab in interface ValueBuilder

Parameters:

tabName - Name of the tab.

Returns:

This builder.

format

public ValueBuilder format(FormatType formatType)

Description copied from interface: ValueBuilder

ValueBuilder.buildNumber(Long) specific method, format the value with FormatType

Specified by:

format in interface ValueBuilder

Returns:

This builder.

showAsPlayerPageLink

public ValueBuilder showAsPlayerPageLink()

Description copied from interface: ValueBuilder

ValueBuilder.buildString(String) specific method, link the value to a player page.

Specified by:

showAsPlayerPageLink in interface ValueBuilder

Returns:

This builder.

hideFromUsers

public ValueBuilder hideFromUsers(BooleanProvider annotation)

Description copied from interface: ValueBuilder

Implementation detail - for abstracting annotations with the builder API.

Specified by:

hideFromUsers in interface ValueBuilder

Parameters:

annotation - BooleanProvider annotation.

Returns:

This builder.

conditional

public ValueBuilder conditional(Conditional conditional)

Description copied from interface: ValueBuilder

Implementation detail - for abstracting annotations with the builder API.

Specified by:

conditional in interface ValueBuilder

Parameters:

conditional - Conditional annotation.

Returns:

This builder.

buildBoolean

public DataValue<java.lang.Boolean> buildBoolean(boolean value)

Description copied from interface: ValueBuilder

Build a Boolean. Displayed as "Yes/No" on the page.

Specified by:

buildBoolean in interface ValueBuilder

Parameters:

value - true/false

Returns:

a data value to give to ExtensionDataBuilder.

buildBooleanProvidingCondition

public DataValue<java.lang.Boolean> buildBooleanProvidingCondition(boolean value,
                                                                   java.lang.String providedCondition)

Description copied from interface: ValueBuilder

Build a Boolean that provides a value for Conditional. Displayed as "Yes/No" on the page.

Specified by:

buildBooleanProvidingCondition in interface ValueBuilder

Parameters:

value - true/false

Returns:

a data value to give to ExtensionDataBuilder.

buildString

public DataValue<java.lang.String> buildString(java.lang.String value)

Description copied from interface: ValueBuilder

Build a String.

Specified by:

buildString in interface ValueBuilder

Parameters:

value - any string. Limited to 50 characters.

Returns:

a data value to give to ExtensionDataBuilder.

buildNumber

public DataValue<java.lang.Long> buildNumber(java.lang.Long value)

Description copied from interface: ValueBuilder

Build a Number.

Specified by:

buildNumber in interface ValueBuilder

Parameters:

value - a non-floating point number.

Returns:

a data value to give to ExtensionDataBuilder.

buildDouble

public DataValue<java.lang.Double> buildDouble(java.lang.Double value)

Description copied from interface: ValueBuilder

Build a Floating point number.

Specified by:

buildDouble in interface ValueBuilder

Parameters:

value - a floating point number.

Returns:

a data value to give to ExtensionDataBuilder.

buildPercentage

public DataValue<java.lang.Double> buildPercentage(java.lang.Double value)

Description copied from interface: ValueBuilder

Build a Percentage.

Specified by:

buildPercentage in interface ValueBuilder

Parameters:

value - value between 0.0 and 1.0

Returns:

a data value to give to ExtensionDataBuilder.

buildGroup

public DataValue<java.lang.String[]> buildGroup(java.lang.String[] groups)

Description copied from interface: ValueBuilder

Build a list of groups.

Specified by:

buildGroup in interface ValueBuilder

Parameters:

groups - names of groups a player is in.

Returns:

a data value to give to ExtensionDataBuilder.

buildBoolean

public DataValue<java.lang.Boolean> buildBoolean(java.util.function.Supplier<java.lang.Boolean> value)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildBoolean(boolean)

Specified by:

buildBoolean in interface ValueBuilder

buildBooleanProvidingCondition

public DataValue<java.lang.Boolean> buildBooleanProvidingCondition(java.util.function.Supplier<java.lang.Boolean> value,
                                                                   java.lang.String providedCondition)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildBooleanProvidingCondition(boolean, String)

Specified by:

buildBooleanProvidingCondition in interface ValueBuilder

buildString

public DataValue<java.lang.String> buildString(java.util.function.Supplier<java.lang.String> value)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildString(String)

Specified by:

buildString in interface ValueBuilder

buildNumber

public DataValue<java.lang.Long> buildNumber(java.util.function.Supplier<java.lang.Long> value)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildNumber(Long)

Specified by:

buildNumber in interface ValueBuilder

buildDouble

public DataValue<java.lang.Double> buildDouble(java.util.function.Supplier<java.lang.Double> value)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildDouble(Double)

Specified by:

buildDouble in interface ValueBuilder

buildPercentage

public DataValue<java.lang.Double> buildPercentage(java.util.function.Supplier<java.lang.Double> percentage)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildPercentage(Double)

Specified by:

buildPercentage in interface ValueBuilder

buildGroup

public DataValue<java.lang.String[]> buildGroup(java.util.function.Supplier<java.lang.String[]> groups)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildGroup(String[])

Specified by:

buildGroup in interface ValueBuilder

buildTable

public DataValue<Table> buildTable(Table table,
                                   Color tableColor)

Description copied from interface: ValueBuilder

Build a table.

Specified by:

buildTable in interface ValueBuilder

Parameters:

table - Table built using Table.builder()

tableColor - Color of the table

Returns:

a data value to give to ExtensionDataBuilder.

buildTable

public DataValue<Table> buildTable(java.util.function.Supplier<Table> table,
                                   Color tableColor)

Description copied from interface: ValueBuilder

Lambda version for conditional return or throwing NotReadyException.

ValueBuilder.buildTable(Table, Color)

Specified by:

buildTable in interface ValueBuilder