NameStyle (Spedran 1.0.2 API)

java.lang.Object
- com.treescrub.spedran.data.NameStyle

```
public class NameStyle
extends Object
```
Describes how the name for a User should be colored.
If the style is a gradient, getStartColor() and getEndColor() can be identical.

This class is immutable and thread-safe.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NameStyle.Style
The styling type for a given name styling.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<NameColor>`	`getColor()`	Gets the color when `getStyle()` is `NameStyle.Style.SOLID`.
`Optional<NameColor>`	`getEndColor()`	Gets the end or rightmost color when `getStyle()` is `NameStyle.Style.GRADIENT`.
`Optional<NameColor>`	`getStartColor()`	Gets the start or leftmost color when `getStyle()` is `NameStyle.Style.GRADIENT`.
`NameStyle.Style`	`getStyle()`	Gets the style of the name.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getStyle
```
public NameStyle.Style getStyle()
```
    Gets the style of the name.
    If NameStyle.Style.SOLID, the name color will be solid and getColor() will have the color preset.
    If NameStyle.Style.GRADIENT, the name color will be a gradient left to right, from getStartColor() to getEndColor().
    
    Returns:
    
    the color style for the user
  - getColor
```
public Optional<NameColor> getColor()
```
    Gets the color when getStyle() is NameStyle.Style.SOLID.
    
    Returns:
    
    an Optional with the NameColor if the style is solid, otherwise empty.
  - getStartColor
```
public Optional<NameColor> getStartColor()
```
    Gets the start or leftmost color when getStyle() is NameStyle.Style.GRADIENT.
    
    Returns:
    
    the starting NameColor
  - getEndColor
```
public Optional<NameColor> getEndColor()
```
    Gets the end or rightmost color when getStyle() is NameStyle.Style.GRADIENT.
    
    Returns:
    
    the ending NameColor
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object