org.spongepowered.api.text

Class TextTemplate.Arg

java.lang.Object

org.spongepowered.api.text.TextTemplate.Arg

All Implemented Interfaces:

TextElement, TextRepresentable

Enclosing class:

TextTemplate

@ConfigSerializable
public static final class TextTemplate.Arg
extends Object
implements TextRepresentable

Represents a variable element within a TextTemplate. Arguments are replaced by parameters in TextTemplate.apply(Map).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextTemplate.Arg.Builder Represents a builder for TextTemplate.Args.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCloseArgString() Returns the end string of the Arg's container.
Optional<Text>	getDefaultValue() Returns the default value to use if the Arg isOptional() and no parameter is supplied.
TextFormat	getFormat() Returns the base format to be applied to this Arg.
String	getName() Returns the name of this argument to be matched with incoming parameters.
String	getOpenArgString() Returns the beginning string of the Arg's container.
int	hashCode()
boolean	isOptional() Returns true if this Arg is optional.
String	toString()
Text	toText() Gets the textual representation of this instance for its usage in other Text objects.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Method Detail

getName

public String getName()

Returns the name of this argument to be matched with incoming parameters.

Returns:

Argument name

isOptional

public boolean isOptional()

Returns true if this Arg is optional. If a parameter is missing for a non-optional Arg, a TextTemplateArgumentException will be thrown.

Returns:

True if optional

getDefaultValue

public Optional<Text> getDefaultValue()

Returns the default value to use if the Arg isOptional() and no parameter is supplied.

Returns:

Default value

getFormat

public TextFormat getFormat()

Returns the base format to be applied to this Arg.

Returns:

Base format

getOpenArgString

public String getOpenArgString()

Returns the beginning string of the Arg's container.

Returns:

Open string

getCloseArgString

public String getCloseArgString()

Returns the end string of the Arg's container.

Returns:

Close string

toText

public Text toText()

Description copied from interface: TextRepresentable

Gets the textual representation of this instance for its usage in other Text objects. This may but does not need to include hover texts or other actions. This method is basically the toString() equivalent for Texts.

Specified by:

toText in interface TextRepresentable

Returns:

The text instance representing this instance

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object