com.amoebaman.kitmaster.objects
Enum Attribute

java.lang.Object
  java.lang.Enum<Attribute>
      com.amoebaman.kitmaster.objects.Attribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Attribute>

public enum Attribute
extends java.lang.Enum<Attribute>

Enum Constant Summary

CASH
Attribute that determines the amount of currency which will be given as part of the kit.

CLEAR_ALL
Attribute that amounts to a blanket application of all other "CLEAR" attributes

CLEAR_EFFECTS
Attribute that determines whether the kit will clear all potion effects before it is given.

CLEAR_INVENTORY
Attribute that determines whether the kit will clear the player's inventory before it is given.

CLEAR_PERMISSIONS
Attribute that determines whether the kit will remove all previously kit-applied permissions before it is given.

COST
Attribute that determines the effective cost of the kit.

GLOBAL_TIMEOUT
Attribute that determines whether the kit will apply the same timeout to all players on the server.

IDENTIFIER
An identifier string used exclusively by third-party plugins to identify kits by means other than their names.

INFINITE_EFFECTS
Attribute that determines whether the kit will infinitely renew its potion effects (until cleared).

INHERIT_PARENT_PERMS
Attribute that determines whether the kit will consider its parent's permissions to apply to itself.

PARENT
Attribute that links the kit to its intended parent by the parent's name.

REQUIRE_PARENT_PERMS
Attribute that determines whether the kit will require its parent's permissions as a supplement to its own.

SHOW_IN_LIST
Attribute that determines whether the kit will show in the /kitlist list.

SUPPRESS_LOAD_NOTIFICATION
Attribute that determines whether the kit should suppress its notification when loaded.

TIMEOUT
Attribute that defines the timeout of this kit in seconds

UPGRADE_PARENT
Attribute that determines whether the kit will attempt to blend its items and effects into those of its parents.

Field Summary

java.lang.Class<?>	clazz The class type that this attribute is defined by
java.lang.Object	def The default value of this attribute if it is not explicitly defined in the kit's YAML file
java.lang.String	path The YAML path that is used to define this attribute when loading kits

Method Summary

static Attribute	matchName(java.lang.String str) Attempts to grab the Attribute that matches the given String.
java.lang.String	toString() Gets a more user-friendly version of this Attribute's enumerated name.
static Attribute	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Attribute[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TIMEOUT

public static final Attribute TIMEOUT

Attribute that defines the timeout of this kit in seconds

GLOBAL_TIMEOUT

public static final Attribute GLOBAL_TIMEOUT

Attribute that determines whether the kit will apply the same timeout to all players on the server.

INFINITE_EFFECTS

public static final Attribute INFINITE_EFFECTS

Attribute that determines whether the kit will infinitely renew its potion effects (until cleared).

CLEAR_ALL

public static final Attribute CLEAR_ALL

Attribute that amounts to a blanket application of all other "CLEAR" attributes

CLEAR_INVENTORY

public static final Attribute CLEAR_INVENTORY

Attribute that determines whether the kit will clear the player's inventory before it is given.

CLEAR_EFFECTS

public static final Attribute CLEAR_EFFECTS

Attribute that determines whether the kit will clear all potion effects before it is given.

CLEAR_PERMISSIONS

public static final Attribute CLEAR_PERMISSIONS

Attribute that determines whether the kit will remove all previously kit-applied permissions before it is given.

PARENT

public static final Attribute PARENT

Attribute that links the kit to its intended parent by the parent's name.

UPGRADE_PARENT

public static final Attribute UPGRADE_PARENT

Attribute that determines whether the kit will attempt to blend its items and effects into those of its parents.

REQUIRE_PARENT_PERMS

public static final Attribute REQUIRE_PARENT_PERMS

Attribute that determines whether the kit will require its parent's permissions as a supplement to its own.

INHERIT_PARENT_PERMS

public static final Attribute INHERIT_PARENT_PERMS

Attribute that determines whether the kit will consider its parent's permissions to apply to itself.

COST

public static final Attribute COST

Attribute that determines the effective cost of the kit. Only used if the economy handle is grabbed.

CASH

public static final Attribute CASH

Attribute that determines the amount of currency which will be given as part of the kit. Only used if the economy handle is grabbed.

SHOW_IN_LIST

public static final Attribute SHOW_IN_LIST

Attribute that determines whether the kit will show in the /kitlist list.

SUPPRESS_LOAD_NOTIFICATION

public static final Attribute SUPPRESS_LOAD_NOTIFICATION

Attribute that determines whether the kit should suppress its notification when loaded.

IDENTIFIER

public static final Attribute IDENTIFIER

An identifier string used exclusively by third-party plugins to identify kits by means other than their names. Never used in SuperKits.

Field Detail

clazz

public final java.lang.Class<?> clazz

The class type that this attribute is defined by

path

public final java.lang.String path

The YAML path that is used to define this attribute when loading kits

def

public final java.lang.Object def

The default value of this attribute if it is not explicitly defined in the kit's YAML file

Method Detail

values

public static Attribute[] 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 (Attribute c : Attribute.values())
    System.out.println(c);

Returns:

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

valueOf

public static Attribute 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

toString

public java.lang.String toString()

Gets a more user-friendly version of this Attribute's enumerated name.

Overrides:

toString in class java.lang.Enum<Attribute>

matchName

public static Attribute matchName(java.lang.String str)

Attempts to grab the Attribute that matches the given String.

Parameters:

str - The name of the desired attribute.

Returns:

The matched Attribute, or null if no match is found.