Package me.remigio07.chatplugin.api.server.scoreboard

Class Scoreboard.Builder

java.lang.Object

me.remigio07.chatplugin.api.server.scoreboard.Scoreboard.Builder

Enclosing class:

Scoreboard

public abstract static class Scoreboard.Builder
extends Object

Represents the builder used to create Scoreboards using ScoreboardManager.createScoreboardBuilder(String, boolean, List).

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
abstract Scoreboard	build()	Builds the scoreboard.
abstract Scoreboard.Builder	setLine(Map<Language,List<String>> values, int lineIndex, boolean randomOrder, long sendingTimeout)	Sets one of this builder's lines.
abstract Scoreboard.Builder	setNumbers(NumbersDisplayMode displayMode, String customTextValue, long customTextColorsCycleTimeout, int customTextColorsInterpolations, List<ChatColor> customTextColorsGradient)	Sets this builder's numbers.
abstract Scoreboard.Builder	setTitles(Map<Language,List<String>> values, boolean randomOrder, long sendingTimeout)	Sets this builder's titles.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setTitles

public abstract Scoreboard.Builder setTitles(Map<Language,List<String>> values,
 boolean randomOrder,
 long sendingTimeout)

Sets this builder's titles.

Parameters:

values - Titles' values

randomOrder - Whether to use a random order

sendingTimeout - Time between sendings

Returns:

This builder

Throws:

NoSuchElementException - If values.get(Language.getMainLanguage()) == null

setLine

public abstract Scoreboard.Builder setLine(Map<Language,List<String>> values,
 int lineIndex,
 boolean randomOrder,
 long sendingTimeout)

Sets one of this builder's lines.

Parameters:

values - Line's values

lineIndex - Line's index (0 - 14)

randomOrder - Whether to use a random order

sendingTimeout - Time between sendings

Returns:

This builder

Throws:

NoSuchElementException - If values.get(Language.getMainLanguage()) == null

IndexOutOfBoundsException - If lineIndex < 0 || lineIndex > 14

setNumbers

public abstract Scoreboard.Builder setNumbers(NumbersDisplayMode displayMode,
 String customTextValue,
 long customTextColorsCycleTimeout,
 int customTextColorsInterpolations,
 List<ChatColor> customTextColorsGradient)

Sets this builder's numbers.

Parameters:

displayMode - Numbers' display mode

customTextValue - Numbers' custom text's value

customTextColorsCycleTimeout - Time between color cycles

customTextColorsInterpolations - Interpolations between provided colors

customTextColorsGradient - Colors to cycle through

Returns:

This builder

Throws:

UnsupportedOperationException - If !NumbersDisplayMode.isSupported()

IllegalArgumentException - If customTextColorsCycleTimeout < 1 || customTextColorsInterpolations < 0 || customTextColorsGradient.isEmpty()

build

public abstract Scoreboard build()

Builds the scoreboard.

Returns:

New scoreboard

Throws:

IllegalStateException - If one of the following has not been called yet:

• setTitles(Map, boolean, long)
• setLine(Map, int, boolean, long)
• setNumbers(NumbersDisplayMode, String, long, int, List)