Record Class CapabilityBinding<T>

java.lang.Object

java.lang.Record

fr.robie.machineengine.api.machine.CapabilityBinding<T>

Record Components:

sides - faces it is exposed on; empty means "not sided" (any face, or no face)

factory - creates the capability object once per machine instance

public record CapabilityBinding<T>(@NotNull CapabilityType<T> type, @NotNull Set<RelativeSide> sides, @NotNull Function<MachineContext, ? extends T> factory)
extends Record

An extra capability a machine type exposes, besides the resource handlers of its ports.

Constructor Summary

Constructors

Constructor	Description
CapabilityBinding(@NotNull CapabilityType<T> type, @NotNull Set<RelativeSide> sides, @NotNull Function<MachineContext, ? extends T> factory)	Creates an instance of a CapabilityBinding record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull Function<MachineContext, ? extends T>	factory()	Returns the value of the factory record component.
final int	hashCode()	Returns a hash code value for this object.
static <T> @NotNull CapabilityBinding<T>	of(@NotNull CapabilityType<T> type, @NotNull Function<MachineContext, ? extends T> factory)
@NotNull Set<RelativeSide>	sides()	Returns the value of the sides record component.
final String	toString()	Returns a string representation of this record class.
@NotNull CapabilityType<T>	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

CapabilityBinding

public CapabilityBinding(@NotNull
 @NotNull CapabilityType<T> type,
 @NotNull
 @NotNull Set<RelativeSide> sides,
 @NotNull
 @NotNull Function<MachineContext, ? extends T> factory)

Creates an instance of a CapabilityBinding record class.

Parameters:

type - the value for the type record component

sides - the value for the sides record component

factory - the value for the factory record component

Method Details

of

@NotNull
public static <T> @NotNull CapabilityBinding<T> of(@NotNull
 @NotNull CapabilityType<T> type,
 @NotNull
 @NotNull Function<MachineContext, ? extends T> factory)

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. All components in this record class are compared with Objects::equals(Object,Object).

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 CapabilityType<T> type()

Returns the value of the type record component.

Returns:

the value of the type record component

sides

@NotNull
public @NotNull Set<RelativeSide> sides()

Returns the value of the sides record component.

Returns:

the value of the sides record component

factory

@NotNull
public @NotNull Function<MachineContext, ? extends T> factory()

Returns the value of the factory record component.

Returns:

the value of the factory record component