Package net.md_5.bungee.api.chat

Class ComponentStyle

java.lang.Object

net.md_5.bungee.api.chat.ComponentStyle

All Implemented Interfaces:

Cloneable

public final class ComponentStyle
extends Object
implements Cloneable

Represents a style that may be applied to a BaseComponent.

Constructor Summary

Constructors

Constructor	Description
ComponentStyle()
ComponentStyle(ChatColor color, String font, Boolean bold, Boolean italic, Boolean underlined, Boolean strikethrough, Boolean obfuscated)

Method Summary

Modifier and Type	Method	Description
static ComponentStyleBuilder	builder()	Get a new ComponentStyleBuilder.
static ComponentStyleBuilder	builder(ComponentStyle other)	Get a new ComponentStyleBuilder with values initialized to the style values of the supplied ComponentStyle.
ComponentStyle	clone()
boolean	equals(Object o)
ChatColor	getColor()	Returns the color of this style.
String	getFont()	Returns the font of this style.
boolean	hasColor()	Returns whether or not this style has a color set.
boolean	hasFont()	Returns whether or not this style has a font set.
int	hashCode()
boolean	isBold()	Returns whether this style is bold.
Boolean	isBoldRaw()	Returns whether this style is bold.
boolean	isEmpty()	Returns whether this style has any formatting explicitly set.
boolean	isItalic()	Returns whether this style is italic.
Boolean	isItalicRaw()	Returns whether this style is italic.
boolean	isObfuscated()	Returns whether this style is obfuscated.
Boolean	isObfuscatedRaw()	Returns whether this style is obfuscated.
boolean	isStrikethrough()	Returns whether this style is strikethrough
Boolean	isStrikethroughRaw()	Returns whether this style is strikethrough.
boolean	isUnderlined()	Returns whether this style is underlined.
Boolean	isUnderlinedRaw()	Returns whether this style is underlined.
void	setBold(Boolean bold)	Whether this style is bold.
void	setColor(ChatColor color)	The color of this style.
void	setFont(String font)	The font of this style.
void	setItalic(Boolean italic)	Whether this style is italic.
void	setObfuscated(Boolean obfuscated)	Whether this style is obfuscated.
void	setStrikethrough(Boolean strikethrough)	Whether this style is strikethrough.
void	setUnderlined(Boolean underlined)	Whether this style is underlined.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentStyle

public ComponentStyle(ChatColor color,
                      String font,
                      Boolean bold,
                      Boolean italic,
                      Boolean underlined,
                      Boolean strikethrough,
                      Boolean obfuscated)

ComponentStyle

public ComponentStyle()

Method Detail

getColor

public ChatColor getColor()

Returns the color of this style. May return null.

Returns:

the color of this style, or null if default color

hasColor

public boolean hasColor()

Returns whether or not this style has a color set.

Returns:

whether a color is set

getFont

public String getFont()

Returns the font of this style. May return null.

Returns:

the font of this style, or null if default font

hasFont

public boolean hasFont()

Returns whether or not this style has a font set.

Returns:

whether a font is set

isBold

public boolean isBold()

Returns whether this style is bold.

Returns:

whether the style is bold

isBoldRaw

public Boolean isBoldRaw()

Returns whether this style is bold. May return null.

Returns:

whether the style is bold, or null if not set

isItalic

public boolean isItalic()

Returns whether this style is italic. May return null.

Returns:

whether the style is italic

isItalicRaw

public Boolean isItalicRaw()

Returns whether this style is italic. May return null.

Returns:

whether the style is italic, or null if not set

isUnderlined

public boolean isUnderlined()

Returns whether this style is underlined.

Returns:

whether the style is underlined

isUnderlinedRaw

public Boolean isUnderlinedRaw()

Returns whether this style is underlined. May return null.

Returns:

whether the style is underlined, or null if not set

isStrikethrough

public boolean isStrikethrough()

Returns whether this style is strikethrough

Returns:

whether the style is strikethrough

isStrikethroughRaw

public Boolean isStrikethroughRaw()

Returns whether this style is strikethrough. May return null.

Returns:

whether the style is strikethrough, or null if not set

isObfuscated

public boolean isObfuscated()

Returns whether this style is obfuscated.

Returns:

whether the style is obfuscated

isObfuscatedRaw

public Boolean isObfuscatedRaw()

Returns whether this style is obfuscated. May return null.

Returns:

whether the style is obfuscated, or null if not set

isEmpty

public boolean isEmpty()

Returns whether this style has any formatting explicitly set.

Returns:

true if at least one value is set, false if none are set

clone

public ComponentStyle clone()

Overrides:

clone in class Object

builder

public static ComponentStyleBuilder builder()

Get a new ComponentStyleBuilder.

Returns:

the builder

builder

public static ComponentStyleBuilder builder(ComponentStyle other)

Get a new ComponentStyleBuilder with values initialized to the style values of the supplied ComponentStyle.

Parameters:

other - the component style whose values to copy into the builder

Returns:

the builder

setColor

public void setColor(ChatColor color)

The color of this style.

setFont

public void setFont(String font)

The font of this style.

setBold

public void setBold(Boolean bold)

Whether this style is bold.

setItalic

public void setItalic(Boolean italic)

Whether this style is italic.

setUnderlined

public void setUnderlined(Boolean underlined)

Whether this style is underlined.

setStrikethrough

public void setStrikethrough(Boolean strikethrough)

Whether this style is strikethrough.

setObfuscated

public void setObfuscated(Boolean obfuscated)

Whether this style is obfuscated.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object