Package org.atmosphere.cpr

Record Class BroadcastFilter.BroadcastAction

java.lang.Object

java.lang.Record

org.atmosphere.cpr.BroadcastFilter.BroadcastAction

Enclosing interface:

BroadcastFilter

public static record BroadcastFilter.BroadcastAction(BroadcastFilter.BroadcastAction.ACTION action, Object message, Object originalMessage)
extends Record

Simple class that tells the Broadcaster to broadcast or not the transformed value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BroadcastFilter.BroadcastAction.ACTION

Constructor Summary

Constructors

Constructor	Description
BroadcastAction(Object message)
BroadcastAction(BroadcastFilter.BroadcastAction.ACTION action, Object message)
BroadcastAction(BroadcastFilter.BroadcastAction.ACTION action, Object message, Object originalMessage)	Creates an instance of a BroadcastAction record class.

Method Summary

Modifier and Type	Method	Description
BroadcastFilter.BroadcastAction.ACTION	action()	Returns the value of the action 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.
Object	message()	Returns the value of the message record component.
Object	originalMessage()	Returns the value of the originalMessage record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

BroadcastAction

public BroadcastAction(BroadcastFilter.BroadcastAction.ACTION action,
 Object message)

BroadcastAction

public BroadcastAction(Object message)

BroadcastAction

public BroadcastAction(BroadcastFilter.BroadcastAction.ACTION action,
 Object message,
 Object originalMessage)

Creates an instance of a BroadcastAction record class.

Parameters:

action - the value for the action record component

message - the value for the message record component

originalMessage - the value for the originalMessage record component

Method Details

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.

action

public BroadcastFilter.BroadcastAction.ACTION action()

Returns the value of the action record component.

Returns:

the value of the action record component

message

public Object message()

Returns the value of the message record component.

Returns:

the value of the message record component

originalMessage

public Object originalMessage()

Returns the value of the originalMessage record component.

Returns:

the value of the originalMessage record component