Class ExtValueBuilder
java.lang.Object
com.djrapitops.plan.extension.implementation.builder.ExtValueBuilder
- All Implemented Interfaces:
ValueBuilder
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaggregateTypes(Aggregates[] aggregates) ValueBuilder.buildNumber(Long)orValueBuilder.buildDouble(Double)specific method, adds runtime calculated server aggregates across all players.buildBoolean(boolean value) Build a Boolean.buildBoolean(Supplier<Boolean> value) Lambda version for conditional return or throwingNotReadyException.buildBooleanProvidingCondition(boolean value, String providedCondition) Build a Boolean that provides a value forConditional.buildBooleanProvidingCondition(Supplier<Boolean> value, String providedCondition) Lambda version for conditional return or throwingNotReadyException.buildComponent(Component value) Build aComponent.buildComponent(Supplier<Component> value) Lambda version for conditional return or throwingNotReadyException.buildDouble(Double value) Build a Floating point number.buildDouble(Supplier<Double> value) Lambda version for conditional return or throwingNotReadyException.buildGroup(String[] groups) Build a list of groups.buildGroup(Supplier<String[]> groups) Lambda version for conditional return or throwingNotReadyException.buildNumber(Long value) Build a Number.buildNumber(Supplier<Long> value) Lambda version for conditional return or throwingNotReadyException.buildPercentage(Double value) Build a Percentage.buildPercentage(Supplier<Double> percentage) Lambda version for conditional return or throwingNotReadyException.buildProviderInfo(GraphProvider annotation) buildStatistics(Statistics statistics, Color tableColor) Build statistics.buildStatistics(Supplier<Statistics> statistics, Color tableColor) Lambda version for conditional return or throwingNotReadyException.buildString(String value) Build a String.buildString(Supplier<String> value) Lambda version for conditional return or throwingNotReadyException.buildTable(Table table, Color tableColor) Build a table.buildTable(Supplier<Table> table, Color tableColor) Lambda version for conditional return or throwingNotReadyException.conditional(Conditional conditional) Implementation detail - for abstracting annotations with the builder API.description(String description) Description about the value that is shown on hover.format(FormatType formatType) ValueBuilder.buildNumber(Long)specific method, format the value withFormatTypestatic StringformatTextAsIdentifier(String text) getStatisticsProviderInformation(Color tableColor) hideFromUsers(BooleanProvider annotation) Implementation detail - for abstracting annotations with the builder API.Icon displayed next to the value.methodName(ExtensionMethod method) Implementation detail - for abstracting annotations with the builder API.priority(int priority) Display-priority of the value, highest value is placed top most.ValueBuilder.buildString(String)specific method, link the value to a player page.Show this value in the players table.Show the value on a specific tab.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ValueBuilder
buildNumber, buildNumber, formatAsDateWithSeconds, formatAsDateWithYear, formatAsTimeAmount, icon, showAsPlayerPageLink, showInPlayerTable, showOnTab
-
Constructor Details
-
ExtValueBuilder
-
-
Method Details
-
formatTextAsIdentifier
-
methodName
Description copied from interface:ValueBuilderImplementation detail - for abstracting annotations with the builder API.- Specified by:
methodNamein interfaceValueBuilder- Parameters:
method- Method this value is from.- Returns:
- This builder.
-
description
Description copied from interface:ValueBuilderDescription about the value that is shown on hover.- Specified by:
descriptionin interfaceValueBuilder- Parameters:
description- Describe what the value is about, maximum 150 characters.- Returns:
- This builder.
-
priority
Description copied from interface:ValueBuilderDisplay-priority of the value, highest value is placed top most.Two values with same priority may appear in a random order.
- Specified by:
priorityin interfaceValueBuilder- Parameters:
priority- Priority between 0 andInteger.MAX_VALUE.- Returns:
- This builder.
-
showInPlayerTable
Description copied from interface:ValueBuilderShow this value in the players table.- Specified by:
showInPlayerTablein interfaceValueBuilder- Returns:
- This builder.
-
icon
Description copied from interface:ValueBuilderIcon displayed next to the value.See FontAwesome (select 'free')) for icons
- Specified by:
iconin interfaceValueBuilder- Parameters:
icon- Icon built using the methods inIcon.- Returns:
- This builder.
-
showOnTab
Description copied from interface:ValueBuilderShow the value on a specific tab.Remember to define
TabInfoannotation.- Specified by:
showOnTabin interfaceValueBuilder- Parameters:
tabName- Name of the tab.- Returns:
- This builder.
-
format
Description copied from interface:ValueBuilderValueBuilder.buildNumber(Long)specific method, format the value withFormatType- Specified by:
formatin interfaceValueBuilder- Returns:
- This builder.
-
showAsPlayerPageLink
Description copied from interface:ValueBuilderValueBuilder.buildString(String)specific method, link the value to a player page.- Specified by:
showAsPlayerPageLinkin interfaceValueBuilder- Returns:
- This builder.
-
hideFromUsers
Description copied from interface:ValueBuilderImplementation detail - for abstracting annotations with the builder API.- Specified by:
hideFromUsersin interfaceValueBuilder- Parameters:
annotation- BooleanProvider annotation.- Returns:
- This builder.
-
conditional
Description copied from interface:ValueBuilderImplementation detail - for abstracting annotations with the builder API.- Specified by:
conditionalin interfaceValueBuilder- Parameters:
conditional- Conditional annotation.- Returns:
- This builder.
-
aggregateTypes
Description copied from interface:ValueBuilderValueBuilder.buildNumber(Long)orValueBuilder.buildDouble(Double)specific method, adds runtime calculated server aggregates across all players.- Specified by:
aggregateTypesin interfaceValueBuilder- Parameters:
aggregates- Aggregate types.- Returns:
- This builder.
- See Also:
-
buildProviderInfo
-
getStatisticsProviderInformation
-
buildBoolean
Description copied from interface:ValueBuilderBuild a Boolean. Displayed as "Yes/No" on the page.- Specified by:
buildBooleanin interfaceValueBuilder- Parameters:
value- true/false- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildBooleanProvidingCondition
Description copied from interface:ValueBuilderBuild a Boolean that provides a value forConditional. Displayed as "Yes/No" on the page.- Specified by:
buildBooleanProvidingConditionin interfaceValueBuilder- Parameters:
value- true/false- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildString
Description copied from interface:ValueBuilderBuild a String.- Specified by:
buildStringin interfaceValueBuilder- Parameters:
value- any string. Limited to 50 characters.- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildComponent
Description copied from interface:ValueBuilderBuild aComponent.- Specified by:
buildComponentin interfaceValueBuilder- Parameters:
value- aComponentmade byComponentService- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildNumber
Description copied from interface:ValueBuilderBuild a Number.- Specified by:
buildNumberin interfaceValueBuilder- Parameters:
value- a non-floating point number.- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildDouble
Description copied from interface:ValueBuilderBuild a Floating point number.- Specified by:
buildDoublein interfaceValueBuilder- Parameters:
value- a floating point number.- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildPercentage
Description copied from interface:ValueBuilderBuild a Percentage.- Specified by:
buildPercentagein interfaceValueBuilder- Parameters:
value- value between 0.0 and 1.0- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildGroup
Description copied from interface:ValueBuilderBuild a list of groups.- Specified by:
buildGroupin interfaceValueBuilder- Parameters:
groups- names of groups a player is in.- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildBoolean
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildBooleanin interfaceValueBuilder
-
buildBooleanProvidingCondition
public DataValue<Boolean> buildBooleanProvidingCondition(Supplier<Boolean> value, String providedCondition) Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.ValueBuilder.buildBooleanProvidingCondition(boolean, String)- Specified by:
buildBooleanProvidingConditionin interfaceValueBuilder
-
buildString
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildStringin interfaceValueBuilder
-
buildComponent
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildComponentin interfaceValueBuilder
-
buildNumber
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildNumberin interfaceValueBuilder
-
buildDouble
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildDoublein interfaceValueBuilder
-
buildPercentage
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildPercentagein interfaceValueBuilder
-
buildGroup
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildGroupin interfaceValueBuilder
-
buildTable
Description copied from interface:ValueBuilderBuild a table.- Specified by:
buildTablein interfaceValueBuilder- Parameters:
table- Table built usingTable.builder()tableColor- Color of the table- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildTable
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildTablein interfaceValueBuilder
-
buildStatistics
Description copied from interface:ValueBuilderBuild statistics.- Specified by:
buildStatisticsin interfaceValueBuilder- Parameters:
statistics- Statistics built usingStatistics.create()tableColor- Color of the table- Returns:
- a data value to give to
ExtensionDataBuilder.
-
buildStatistics
Description copied from interface:ValueBuilderLambda version for conditional return or throwingNotReadyException.- Specified by:
buildStatisticsin interfaceValueBuilder
-