org.spongepowered.api.util.weighted

Class VariableAmount.OptionalAmount

java.lang.Object

org.spongepowered.api.util.weighted.VariableAmount.OptionalAmount

All Implemented Interfaces:

DataSerializable, VariableAmount

Enclosing interface:

VariableAmount

public static class VariableAmount.OptionalAmount
extends Object
implements VariableAmount

Represents a variable amount which has a base and a chance of varying. This wraps another VariableAmount which it refers to if the chance succeeds.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.util.weighted.VariableAmount

VariableAmount.BaseAndAddition, VariableAmount.BaseAndVariance, VariableAmount.Fixed, VariableAmount.OptionalAmount

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getAmount(Random rand) Gets an instance of the variable amount depending on the given random object.
int	getContentVersion() Gets the content version of this DataSerializable.
int	hashCode()
DataContainer	toContainer() Serializes this object into a comprehensible DataContainer.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.util.weighted.VariableAmount

baseWithOptionalAddition, baseWithOptionalAddition, baseWithOptionalVariance, baseWithOptionalVariance, baseWithRandomAddition, baseWithRandomAddition, baseWithVariance, baseWithVariance, fixed, getFlooredAmount, range

Method Detail

getAmount

public double getAmount(Random rand)

Description copied from interface: VariableAmount

Gets an instance of the variable amount depending on the given random object.

Specified by:

getAmount in interface VariableAmount

Parameters:

rand - The random object

Returns:

The amount

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toContainer

public DataContainer toContainer()

Description copied from interface: DataSerializable

Serializes this object into a comprehensible DataContainer.

Specified by:

toContainer in interface DataSerializable

Specified by:

toContainer in interface VariableAmount

Returns:

A newly created DataContainer

getContentVersion

public int getContentVersion()

Description copied from interface: DataSerializable

Gets the content version of this DataSerializable. The version may differ between instances of plugins and implementations such that the DataView from DataSerializable.toContainer() may include different information, or remove other information as they are no longer deemed necessary. The version goes hand in hand with DataContentUpdater as it is required when there exists any DataView of this DataSerializable with an "older" version.

Specified by:

getContentVersion in interface DataSerializable

Specified by:

getContentVersion in interface VariableAmount

Returns:

The version of the content being serialized