Record Class EventMetadataImpl

java.lang.Object

java.lang.Record

net.flectone.pulse.model.event.EventMetadataImpl

Record Components:

filter - decides which players receive the message

destination - where the message is drawn

range - how far it travels

sound - the sound and the permission to hear it, or null

messageContext - builds the context for a given receiver

proxy - writes the extra proxy payload, or null

integration - supplies the mirroring format, or null

All Implemented Interfaces:

EventMetadata

public record EventMetadataImpl(@NonNull Predicate<FPlayer> filter, @NonNull Destination destination, @NonNull Range range, @Nullable Pair<Sound, PermissionSetting> sound, @NonNull Function<FPlayer, MessageContext> messageContext, @Nullable ProxyDataConsumer<DataOutputStream> proxy, @Nullable Supplier<IntegrationMessageFormat> integration)
extends Record
implements EventMetadata

The plain event metadata every builder produces.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventMetadataImpl.EventMetadataImplBuilder

Nested classes/interfaces inherited from interface EventMetadata

EventMetadata.Builder

Constructor Summary

Constructors

Constructor	Description
EventMetadataImpl(@NonNull Predicate<FPlayer> filter, @NonNull Destination destination, @NonNull Range range, @Nullable Pair<Sound, PermissionSetting> sound, @NonNull Function<FPlayer, MessageContext> messageContext, @Nullable ProxyDataConsumer<DataOutputStream> proxy, @Nullable Supplier<IntegrationMessageFormat> integration)	Creates an instance of a EventMetadataImpl record class.

Method Summary

Modifier and Type	Method	Description
EventMetadataImpl	base()	The underlying metadata this instance delegates to.
static EventMetadataImpl.EventMetadataImplBuilder	builder()
@NonNull Destination	destination()	Returns the value of the destination record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NonNull Predicate<FPlayer>	filter()	Returns the value of the filter record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Supplier<IntegrationMessageFormat>	integration()	Returns the value of the integration record component.
@NonNull Function<FPlayer, MessageContext>	messageContext()	Returns the value of the messageContext record component.
@Nullable ProxyDataConsumer<DataOutputStream>	proxy()	Returns the value of the proxy record component.
@NonNull Range	range()	Returns the value of the range record component.
@NonNull MessageContext	resolveMessageContext(FPlayer fPlayer)	Builds the message context for one receiver, so each player can get their own wording.
@Nullable Pair<Sound, PermissionSetting>	sound()	Returns the value of the sound record component.
final String	toString()	Returns a string representation of this record class.
EventMetadataImpl	withDestination(@NonNull Destination destination)
EventMetadataImpl	withFilter(@NonNull Predicate<FPlayer> filter)
EventMetadataImpl	withIntegration(@Nullable Supplier<IntegrationMessageFormat> integration)
EventMetadataImpl	withMessageContext(@NonNull Function<FPlayer, MessageContext> messageContext)
EventMetadataImpl	withProxy(@Nullable ProxyDataConsumer<DataOutputStream> proxy)
EventMetadataImpl	withRange(@NonNull Range range)
EventMetadataImpl	withSound(@Nullable Pair<Sound, PermissionSetting> sound)

Methods inherited from class Object

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

Methods inherited from interface EventMetadata

resolveIntegrationMessageFormat

Constructor Details

EventMetadataImpl

public EventMetadataImpl(@NonNull Predicate<FPlayer> filter,
 @NonNull Destination destination,
 @NonNull Range range,
 @Nullable Pair<Sound, PermissionSetting> sound,
 @NonNull Function<FPlayer, MessageContext> messageContext,
 @Nullable ProxyDataConsumer<DataOutputStream> proxy,
 @Nullable Supplier<IntegrationMessageFormat> integration)

Creates an instance of a EventMetadataImpl record class.

Parameters:

filter - the value for the filter record component

destination - the value for the destination record component

range - the value for the range record component

sound - the value for the sound record component

messageContext - the value for the messageContext record component

proxy - the value for the proxy record component

integration - the value for the integration record component

Method Details

base

public EventMetadataImpl base()

Description copied from interface: EventMetadata

The underlying metadata this instance delegates to.

Specified by:

base in interface EventMetadata

Returns:

the base metadata

resolveMessageContext

public @NonNull MessageContext resolveMessageContext(FPlayer fPlayer)

Description copied from interface: EventMetadata

Builds the message context for one receiver, so each player can get their own wording.

Specified by:

resolveMessageContext in interface EventMetadata

Parameters:

fPlayer - the receiving player

Returns:

the context for that player

builder

public static EventMetadataImpl.EventMetadataImplBuilder builder()

withFilter

public EventMetadataImpl withFilter(@NonNull Predicate<FPlayer> filter)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withDestination

public EventMetadataImpl withDestination(@NonNull Destination destination)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withRange

public EventMetadataImpl withRange(@NonNull Range range)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withSound

public EventMetadataImpl withSound(@Nullable Pair<Sound, PermissionSetting> sound)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withMessageContext

public EventMetadataImpl withMessageContext(@NonNull Function<FPlayer, MessageContext> messageContext)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withProxy

public EventMetadataImpl withProxy(@Nullable ProxyDataConsumer<DataOutputStream> proxy)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

withIntegration

public EventMetadataImpl withIntegration(@Nullable Supplier<IntegrationMessageFormat> integration)

Returns:

a clone of this object, except with this updated property (returns this if an identical value is passed).

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.

filter

public @NonNull Predicate<FPlayer> filter()

Returns the value of the filter record component.

Specified by:

filter in interface EventMetadata

Returns:

the value of the filter record component

destination

public @NonNull Destination destination()

Returns the value of the destination record component.

Specified by:

destination in interface EventMetadata

Returns:

the value of the destination record component

range

public @NonNull Range range()

Returns the value of the range record component.

Specified by:

range in interface EventMetadata

Returns:

the value of the range record component

sound

public @Nullable Pair<Sound, PermissionSetting> sound()

Returns the value of the sound record component.

Specified by:

sound in interface EventMetadata

Returns:

the value of the sound record component

messageContext

public @NonNull Function<FPlayer, MessageContext> messageContext()

Returns the value of the messageContext record component.

Returns:

the value of the messageContext record component

proxy

public @Nullable ProxyDataConsumer<DataOutputStream> proxy()

Returns the value of the proxy record component.

Specified by:

proxy in interface EventMetadata

Returns:

the value of the proxy record component

integration

public @Nullable Supplier<IntegrationMessageFormat> integration()

Returns the value of the integration record component.

Specified by:

integration in interface EventMetadata

Returns:

the value of the integration record component