Record Class StorageView

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.transfer.StorageView

Record Components:

variant - what the slot holds, or null if it is empty

amount - how much it holds

capacity - how much it can hold

public record StorageView(@Nullable ResourceVariant variant, long amount, long capacity)
extends Record

A read-only snapshot of one storage slot.

Constructor Summary

Constructors

Constructor	Description
StorageView(@Nullable ResourceVariant variant, long amount, long capacity)	Creates an instance of a StorageView record class.

Method Summary

Modifier and Type	Method	Description
long	amount()	Returns the value of the amount record component.
long	capacity()	Returns the value of the capacity record component.
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.
boolean	isEmpty()
final String	toString()	Returns a string representation of this record class.
@Nullable ResourceVariant	variant()	Returns the value of the variant record component.

Methods inherited from class Object

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

Constructor Details

StorageView

public StorageView(@Nullable
 @Nullable ResourceVariant variant,
 long amount,
 long capacity)

Creates an instance of a StorageView record class.

Parameters:

variant - the value for the variant record component

amount - the value for the amount record component

capacity - the value for the capacity record component

Method Details

isEmpty

public boolean isEmpty()

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.

variant

@Nullable
public @Nullable ResourceVariant variant()

Returns the value of the variant record component.

Returns:

the value of the variant record component

amount

public long amount()

Returns the value of the amount record component.

Returns:

the value of the amount record component

capacity

public long capacity()

Returns the value of the capacity record component.

Returns:

the value of the capacity record component