Record Class MessagePrepareEvent

java.lang.Object

java.lang.Record

net.flectone.pulse.model.event.message.MessagePrepareEvent

All Implemented Interfaces:

Event

public record MessagePrepareEvent(boolean cancelled, MessagePrepareEvent.Type type, ModuleName moduleName, String rawFormat, EventMetadata<?> eventMetadata)
extends Record
implements Event

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessagePrepareEvent.Type

Nested classes/interfaces inherited from interface Event

Event.Priority

Constructor Summary

Constructors

Constructor	Description
MessagePrepareEvent(boolean cancelled, MessagePrepareEvent.Type type, ModuleName moduleName, String rawFormat, EventMetadata<?> eventMetadata)	Creates an instance of a MessagePrepareEvent record class.
MessagePrepareEvent(MessagePrepareEvent.Type type, ModuleName moduleName, String rawFormat, EventMetadata<?> eventMetadata)
MessagePrepareEvent(ModuleName moduleName, String rawFormat, EventMetadata<?> eventMetadata)

Method Summary

Modifier and Type	Method	Description
boolean	cancelled()	Returns the value of the cancelled record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
EventMetadata<?>	eventMetadata()	Returns the value of the eventMetadata record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isForIntegration()
boolean	isForProxy()
ModuleName	moduleName()	Returns the value of the moduleName record component.
String	rawFormat()	Returns the value of the rawFormat record component.
final String	toString()	Returns a string representation of this record class.
MessagePrepareEvent.Type	type()	Returns the value of the type record component.
MessagePrepareEvent	withCancelled(boolean cancelled)
MessagePrepareEvent	withEventMetadata(EventMetadata<?> eventMetadata)
MessagePrepareEvent	withModuleName(ModuleName moduleName)
MessagePrepareEvent	withRawFormat(String rawFormat)
MessagePrepareEvent	withType(MessagePrepareEvent.Type type)

Methods inherited from class Object

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

Constructor Details

MessagePrepareEvent

public MessagePrepareEvent(ModuleName moduleName,
 String rawFormat,
 EventMetadata<?> eventMetadata)

MessagePrepareEvent

public MessagePrepareEvent(MessagePrepareEvent.Type type,
 ModuleName moduleName,
 String rawFormat,
 EventMetadata<?> eventMetadata)

MessagePrepareEvent

public MessagePrepareEvent(boolean cancelled,
 MessagePrepareEvent.Type type,
 ModuleName moduleName,
 String rawFormat,
 EventMetadata<?> eventMetadata)

Creates an instance of a MessagePrepareEvent record class.

Parameters:

cancelled - the value for the cancelled record component

type - the value for the type record component

moduleName - the value for the moduleName record component

rawFormat - the value for the rawFormat record component

eventMetadata - the value for the eventMetadata record component

Method Details

isForProxy

public boolean isForProxy()

isForIntegration

public boolean isForIntegration()

withCancelled

public MessagePrepareEvent withCancelled(boolean cancelled)

Specified by:

withCancelled in interface Event

Returns:

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

withType

public MessagePrepareEvent withType(MessagePrepareEvent.Type type)

Returns:

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

withModuleName

public MessagePrepareEvent withModuleName(ModuleName moduleName)

Returns:

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

withRawFormat

public MessagePrepareEvent withRawFormat(String rawFormat)

Returns:

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

withEventMetadata

public MessagePrepareEvent withEventMetadata(EventMetadata<?> eventMetadata)

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. 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.

cancelled

public boolean cancelled()

Returns the value of the cancelled record component.

Specified by:

cancelled in interface Event

Returns:

the value of the cancelled record component

type

public MessagePrepareEvent.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

moduleName

public ModuleName moduleName()

Returns the value of the moduleName record component.

Returns:

the value of the moduleName record component

rawFormat

public String rawFormat()

Returns the value of the rawFormat record component.

Returns:

the value of the rawFormat record component

eventMetadata

public EventMetadata<?> eventMetadata()

Returns the value of the eventMetadata record component.

Returns:

the value of the eventMetadata record component