com.comphenix.protocol.wrappers

Class WrappedAttributeModifier.Builder

java.lang.Object

com.comphenix.protocol.wrappers.WrappedAttributeModifier.Builder

Enclosing class:

WrappedAttributeModifier

public static class WrappedAttributeModifier.Builder
extends java.lang.Object

Represents a builder of attribute modifiers.

Use WrappedAttributeModifier.newBuilder() to construct an instance of the builder.

Author:

Kristian

Method Summary

Methods

Modifier and Type	Method and Description
WrappedAttributeModifier.Builder	amount(double amount) Set the amount to modify in the operation.
WrappedAttributeModifier	build() Construct a new attribute modifier and its wrapper using the supplied values in this builder.
WrappedAttributeModifier.Builder	name(java.lang.String name) Set a human readable name of this modifier.
WrappedAttributeModifier.Builder	operation(WrappedAttributeModifier.Operation operation) Set the operation that is used to compute the final attribute value.
WrappedAttributeModifier.Builder	uuid(java.util.UUID uuid) Set the unique UUID that identifies the origin of this modifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

uuid

public WrappedAttributeModifier.Builder uuid(@Nonnull
                                    java.util.UUID uuid)

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

This parameter is automatically supplied with a random UUID, or the UUID from an attribute modifier to clone.

Parameters:

uuid - - the uuid to supply to the new object.

Returns:

This builder, for chaining.

operation

public WrappedAttributeModifier.Builder operation(@Nonnull
                                         WrappedAttributeModifier.Operation operation)

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

Parameters:

operation - - the operation to supply to the new object.

Returns:

This builder, for chaining.

name

public WrappedAttributeModifier.Builder name(@Nonnull
                                    java.lang.String name)

Set a human readable name of this modifier.

Parameters:

name - - the name of the modifier.

Returns:

This builder, for chaining.

amount

public WrappedAttributeModifier.Builder amount(double amount)

Set the amount to modify in the operation.

Parameters:

amount - - the amount to supply to the new object.

Returns:

This builder, for chaining.

build

public WrappedAttributeModifier build()

Construct a new attribute modifier and its wrapper using the supplied values in this builder.

Returns:

The new attribute modifier.

Throws:

java.lang.NullPointerException - If UUID has not been set.

java.lang.RuntimeException - If we are unable to construct the underlying attribute modifier.