Record Class Modifier

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.upgrade.Modifier

Record Components:

value - for Modifier.Operation.ADD an amount in the value's own unit; for the multiplying operations a fraction in permille: 250 is +25 %, -500 is −50 %

public record Modifier(@NotNull ModifierType type, @NotNull Modifier.Operation operation, long value)
extends Record

One change to a ModifierType's value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Modifier.Operation	Applied in this order, like Minecraft attribute modifiers (D16).

Constructor Summary

Constructors

Constructor	Description
Modifier(@NotNull ModifierType type, @NotNull Modifier.Operation operation, long value)	Creates an instance of a Modifier record class.

Method Summary

Modifier and Type	Method	Description
static @NotNull Modifier	add(@NotNull ModifierType type, long amount)
static @NotNull Modifier	addMultipliedBase(@NotNull ModifierType type, long permille)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static @NotNull Modifier	multiplyTotal(@NotNull ModifierType type, long permille)
@NotNull Modifier.Operation	operation()	Returns the value of the operation record component.
final String	toString()	Returns a string representation of this record class.
@NotNull ModifierType	type()	Returns the value of the type record component.
long	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Constructor Details

Modifier

public Modifier(@NotNull
 @NotNull ModifierType type,
 @NotNull
 @NotNull Modifier.Operation operation,
 long value)

Creates an instance of a Modifier record class.

Parameters:

type - the value for the type record component

operation - the value for the operation record component

value - the value for the value record component

Method Details

add

@NotNull
public static @NotNull Modifier add(@NotNull
 @NotNull ModifierType type,
 long amount)

addMultipliedBase

@NotNull
public static @NotNull Modifier addMultipliedBase(@NotNull
 @NotNull ModifierType type,
 long permille)

multiplyTotal

@NotNull
public static @NotNull Modifier multiplyTotal(@NotNull
 @NotNull ModifierType type,
 long permille)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

@NotNull
public @NotNull ModifierType type()

Returns the value of the type record component.

Returns:

the value of the type record component

operation

@NotNull
public @NotNull Modifier.Operation operation()

Returns the value of the operation record component.

Returns:

the value of the operation record component

value

public long value()

Returns the value of the value record component.

Returns:

the value of the value record component