com.comphenix.protocol.wrappers

Class WrappedAttributeModifier

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.WrappedAttributeModifier

public class WrappedAttributeModifier
extends AbstractWrapper

Represents a wrapper around a AttributeModifier.

This is used to compute the final attribute value.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappedAttributeModifier.Builder Represents a builder of attribute modifiers.
static class	WrappedAttributeModifier.Operation Represents the different modifier operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructureModifier<java.lang.Object>	modifier

Fields inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

handle, handleType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappedAttributeModifier(java.lang.Object handle) Construct an attribute modifier wrapper around a given NMS instance.
protected	WrappedAttributeModifier(java.lang.Object handle, java.util.UUID uuid, java.lang.String name, double amount, WrappedAttributeModifier.Operation operation) Construct an attribute modifier wrapper around a NMS instance.
protected	WrappedAttributeModifier(java.util.UUID uuid, java.lang.String name, double amount, WrappedAttributeModifier.Operation operation) Construct a new wrapped attribute modifier with no associated handle.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determine if a given modifier is equal to the current modifier.
static WrappedAttributeModifier	fromHandle(java.lang.Object handle) Construct an attribute modifier wrapper around a given NMS instance.
double	getAmount() Retrieve the amount to modify in the operation.
java.lang.Object	getHandle() Retrieve the underlying attribute modifier.
java.lang.String	getName() Retrieve a human readable name of this modifier.
WrappedAttributeModifier.Operation	getOperation() Retrieve the operation that is used to compute the final attribute value.
java.util.UUID	getUUID() Retrieve the unique UUID that identifies the origin of this modifier.
int	hashCode()
boolean	isPendingSynchronization() Whether or not the modifier is pending synchronization with the client.
static WrappedAttributeModifier.Builder	newBuilder() Construct a new attribute modifier builder.
static WrappedAttributeModifier.Builder	newBuilder(java.util.UUID id) Construct a new attribute modifier builder with the given UUID.
static WrappedAttributeModifier.Builder	newBuilder(WrappedAttributeModifier template) Construct a new wrapped attribute modifier builder initialized to the values from a template.
void	setPendingSynchronization(boolean pending) Set whether or not the modifier is pending synchronization with the client.
java.lang.String	toString()

Methods inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

getHandleType, setHandle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

modifier

protected StructureModifier<java.lang.Object> modifier

Constructor Detail

WrappedAttributeModifier

protected WrappedAttributeModifier(java.util.UUID uuid,
                        java.lang.String name,
                        double amount,
                        WrappedAttributeModifier.Operation operation)

Construct a new wrapped attribute modifier with no associated handle.

Note that the handle object is not initialized after this constructor.

Parameters:

uuid - - the UUID.

name - - the human readable name.

amount - - the amount.

operation - - the operation.

WrappedAttributeModifier

protected WrappedAttributeModifier(@Nonnull
                        java.lang.Object handle)

Construct an attribute modifier wrapper around a given NMS instance.

Parameters:

handle - - the NMS instance.

WrappedAttributeModifier

protected WrappedAttributeModifier(@Nonnull
                        java.lang.Object handle,
                        java.util.UUID uuid,
                        java.lang.String name,
                        double amount,
                        WrappedAttributeModifier.Operation operation)

Construct an attribute modifier wrapper around a NMS instance.

Parameters:

handle - - the NMS instance.

uuid - - the UUID.

name - - the human readable name.

amount - - the amount.

operation - - the operation.

Method Detail

newBuilder

public static WrappedAttributeModifier.Builder newBuilder()

Construct a new attribute modifier builder.

It will automatically be supplied with a random UUID.

Returns:

The new builder.

newBuilder

public static WrappedAttributeModifier.Builder newBuilder(java.util.UUID id)

Construct a new attribute modifier builder with the given UUID.

Parameters:

id - - the new UUID.

Returns:

Thew new builder.

newBuilder

public static WrappedAttributeModifier.Builder newBuilder(@Nonnull
                                          WrappedAttributeModifier template)

Construct a new wrapped attribute modifier builder initialized to the values from a template.

Parameters:

template - - the attribute modifier template.

Returns:

The new builder.

fromHandle

public static WrappedAttributeModifier fromHandle(@Nonnull
                                  java.lang.Object handle)

Construct an attribute modifier wrapper around a given NMS instance.

Parameters:

handle - - the NMS instance.

Returns:

The created attribute modifier.

Throws:

java.lang.IllegalArgumentException - If the handle is not an AttributeModifier.

getUUID

public java.util.UUID getUUID()

Retrieve the unique UUID that identifies the origin of this modifier.

Returns:

The unique UUID.

getName

public java.lang.String getName()

Retrieve a human readable name of this modifier.

Note that this will be "Unknown synced attribute modifier" on the client side.

Returns:

The attribute key.

getOperation

public WrappedAttributeModifier.Operation getOperation()

Retrieve the operation that is used to compute the final attribute value.

Returns:

The operation.

getAmount

public double getAmount()

Retrieve the amount to modify in the operation.

Returns:

The amount.

getHandle

public java.lang.Object getHandle()

Retrieve the underlying attribute modifier.

Overrides:

getHandle in class AbstractWrapper

Returns:

The underlying modifier.

setPendingSynchronization

public void setPendingSynchronization(boolean pending)

Set whether or not the modifier is pending synchronization with the client.

This value will be disregarded for equals(Object).

Parameters:

pending - - TRUE if is is, FALSE otherwise.

isPendingSynchronization

public boolean isPendingSynchronization()

Whether or not the modifier is pending synchronization with the client.

Returns:

TRUE if it is, FALSE otherwise.

equals

public boolean equals(java.lang.Object obj)

Determine if a given modifier is equal to the current modifier.

Two modifiers are considered equal if they use the same UUID.

Overrides:

equals in class java.lang.Object

Parameters:

obj - - the object to check against.

Returns:

TRUE if the given object is the same, FALSE otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object