Package com.djrapitops.plan.extension.icon

Enum Class Family

java.lang.Object

java.lang.Enum<Family>

com.djrapitops.plan.extension.icon.Family

All Implemented Interfaces:

Serializable, Comparable<Family>, Constable

public enum Family
extends Enum<Family>

Enum to determine font-awesome icon family.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRAND	'fab' (brand) Font awesome family.
REGULAR	'far' (regular) Font awesome family.
SOLID	'fas' (solid) Font awesome family.

Method Summary

Modifier and Type	Method	Description
static Optional<Family>	getByName(String name)	Get a family by the enum name without exception.
static Family	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Family[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SOLID

public static final Family SOLID

'fas' (solid) Font awesome family.

REGULAR

public static final Family REGULAR

'far' (regular) Font awesome family.

BRAND

public static final Family BRAND

'fab' (brand) Font awesome family.

Method Details

values

public static Family[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Family valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getByName

public static Optional<Family> getByName(String name)

Get a family by the enum name without exception.

Parameters:

name - Family#name()

Returns:

Optional if the family is found by that name, empty if not found.