io.github.nucleuspowered.nucleus.api.module.nickname.exception

Enum NicknameException.Type

java.lang.Object

java.lang.Enum<NicknameException.Type>

io.github.nucleuspowered.nucleus.api.module.nickname.exception.NicknameException.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NicknameException.Type>

Enclosing class:

NicknameException

public static enum NicknameException.Type
extends java.lang.Enum<NicknameException.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENT_CANCELLED The nickname event was cancelled by a plugin
INVALID_PATTERN This nickname does not conform to the nickname in the config
INVALID_STYLE_OR_COLOUR The user has not got permission to use a style or colour
NO_USER The user cannot be found in the Nucleus system
NOT_OWN_IGN If a nickname is an IGN, but not their own
TOO_LONG This nickname is too long
TOO_SHORT This nickname is too short

Method Summary

Modifier and Type	Method and Description
static NicknameException.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NicknameException.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_OWN_IGN

public static final NicknameException.Type NOT_OWN_IGN

If a nickname is an IGN, but not their own

INVALID_STYLE_OR_COLOUR

public static final NicknameException.Type INVALID_STYLE_OR_COLOUR

The user has not got permission to use a style or colour

INVALID_PATTERN

public static final NicknameException.Type INVALID_PATTERN

This nickname does not conform to the nickname in the config

TOO_SHORT

public static final NicknameException.Type TOO_SHORT

This nickname is too short

TOO_LONG

public static final NicknameException.Type TOO_LONG

This nickname is too long

EVENT_CANCELLED

public static final NicknameException.Type EVENT_CANCELLED

The nickname event was cancelled by a plugin

NO_USER

public static final NicknameException.Type NO_USER

The user cannot be found in the Nucleus system

Method Detail

values

public static NicknameException.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NicknameException.Type c : NicknameException.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static NicknameException.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null