com.comphenix.protocol.wrappers

Enum WrappedAttributeModifier.Operation

java.lang.Object

java.lang.Enum<WrappedAttributeModifier.Operation>

com.comphenix.protocol.wrappers.WrappedAttributeModifier.Operation

All Implemented Interfaces:

Serializable, Comparable<WrappedAttributeModifier.Operation>

Enclosing class:

WrappedAttributeModifier

public static enum WrappedAttributeModifier.Operation
extends Enum<WrappedAttributeModifier.Operation>

Represents the different modifier operations.

The final value is computed as follows:

1. Set X = base value.
2. Execute all modifiers with ADD_NUMBER.
3. Set Y = X.
4. Execute all modifiers with MULTIPLY_PERCENTAGE.
5. Execute all modifiers with ADD_PERCENTAGE.
6. Y is the final value.

Author:

Kristian

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_NUMBER Increment X by amount.
ADD_PERCENTAGE Multiply Y by (1 + amount)
MULTIPLY_PERCENTAGE Increment Y by X * amount.

Method Summary

Modifier and Type	Method and Description
static WrappedAttributeModifier.Operation	fromId(int id) Retrieve the associated operation from an ID.
int	getId() Retrieve the unique operation ID.
static WrappedAttributeModifier.Operation	valueOf(String name) Returns the enum constant of this type with the specified name.
static WrappedAttributeModifier.Operation[]	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

ADD_NUMBER

public static final WrappedAttributeModifier.Operation ADD_NUMBER

Increment X by amount.

MULTIPLY_PERCENTAGE

public static final WrappedAttributeModifier.Operation MULTIPLY_PERCENTAGE

Increment Y by X * amount.

ADD_PERCENTAGE

public static final WrappedAttributeModifier.Operation ADD_PERCENTAGE

Multiply Y by (1 + amount)

Method Detail

values

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

Returns:

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

valueOf

public static WrappedAttributeModifier.Operation valueOf(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:

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

NullPointerException - if the argument is null

getId

public int getId()

Retrieve the unique operation ID.

Returns:

Operation ID.

fromId

public static WrappedAttributeModifier.Operation fromId(int id)

Retrieve the associated operation from an ID.

Parameters:

id - - the ID.

Returns:

The operation.