Modifier and Type	Class and Description
public static @interface	WebsocketEvent.Closed Indicates that a `<f:websocket>` has closed.
public static @interface	WebsocketEvent.Opened Indicates that a `<f:websocket>` has opened.

Modifier and Type	Field and Description
private final String	channel
private final CloseReason.CloseCode	code
private static final long	serialVersionUID
private final Serializable	user

Access	Constructor and Description
public	WebsocketEvent(String channel, Serializable user, CloseReason.CloseCode code)

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: The web socket channel name. getChannel() Returns the `<f:websocket channel>`.
public CloseReason.CloseCode	Returns: The close code. getCloseCode() Returns the close code.
public < The generic type of the user identifier. S extends Serializable> S	Returns: The web socket user identifier, if any. getUser() Returns the `<f:websocket user>`, if any.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

channel	back to summary
private final String channel

code	back to summary
private final CloseReason.CloseCode code

serialVersionUID	back to summary
private static final long serialVersionUID

user	back to summary
private final Serializable user

WebsocketEvent	back to summary
public WebsocketEvent(String channel, Serializable user, CloseReason.CloseCode code)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getChannel back to summary

getChannel	back to summary
public String getChannel() Returns the `<f:websocket channel>`. Returns:String The web socket channel name.

public String getChannel()

Returns the <f:websocket channel>.

Returns:String: The web socket channel name.

getCloseCode back to summary

getCloseCode	back to summary
public CloseReason.CloseCode getCloseCode() Returns the close code. If this returns `null`, then it was `Opened`. If this returns non-`null`, then it was `Closed`. Returns:CloseReason.CloseCode The close code.

public CloseReason.CloseCode getCloseCode()

Returns the close code. If this returns null, then it was Opened. If this returns non-null, then it was Closed.

Returns:CloseReason.CloseCode: The close code.

getUser back to summary

getUser	back to summary
public <S extends Serializable> S getUser() Returns the `<f:websocket user>`, if any. Parameters <S> The generic type of the user identifier. Returns:S The web socket user identifier, if any. Annotations @SuppressWarnings:unchecked Exceptions ClassCastException: When `S` is of wrong type.

public <S extends Serializable> S getUser()

Returns the <f:websocket user>, if any.

Parameters

<S>: The generic type of the user identifier.

Returns:S

The web socket user identifier, if any.

Annotations

@SuppressWarnings:unchecked

Exceptions

ClassCastException:: When S is of wrong type.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

jakarta.faces.event back to summary

public @Interface WebsocketEvent.Closed

Known Direct Implementers

extends Annotationjakarta.faces.event.WebsocketEvent.Closed.Literal

Annotations

@Qualifier
@Target:PARAMETER
@Retention:RUNTIME
@Documented

Indicates that a <f:websocket> has closed.

For detailed usage instructions, see @Push javadoc.

Since: 2.3
See Also: Push

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebsocketEvent.Closed.Literal Supports inline instantiation of the `Closed` qualifier.

Method Summary

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

jakarta.faces.event back to summary

public final Class WebsocketEvent.Closed.Literal

Class Inheritance

extends AnnotationLiteral<WebsocketEvent.Closed>
implements Closed

java.lang.Object
jakarta.enterprise.util.AnnotationLiteral
jakarta.faces.event.WebsocketEvent.Closed.Literal

All Implemented Interfaces

jakarta.faces.event.WebsocketEvent.Closed, java.lang.annotation.Annotation

Supports inline instantiation of the Closed qualifier.

Since: 4.0

Field Summary

Modifier and Type	Field and Description
public static final WebsocketEvent.Closed.Literal	INSTANCE Instance of the `Closed` qualifier.
private static final long	serialVersionUID Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	Literal()

Method Summary

Inherited from jakarta.enterprise.util.AnnotationLiteral:: annotationType equals hashCode toString

Field Detail

INSTANCE	back to summary
public static final WebsocketEvent.Closed.Literal INSTANCE Instance of the `Closed` qualifier.

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Detail

Literal	back to summary
public Literal()

jakarta.faces.event back to summary

public @Interface WebsocketEvent.Opened

Known Direct Implementers

extends Annotationjakarta.faces.event.WebsocketEvent.Opened.Literal

Annotations

@Qualifier
@Target:PARAMETER
@Retention:RUNTIME
@Documented

Indicates that a <f:websocket> has opened.

For detailed usage instructions, see @Push javadoc.

Since: 2.3
See Also: Push

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WebsocketEvent.Opened.Literal Supports inline instantiation of the `Opened` qualifier.

Method Summary

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

jakarta.faces.event back to summary

public final Class WebsocketEvent.Opened.Literal

Class Inheritance

extends AnnotationLiteral<WebsocketEvent.Opened>
implements Opened

java.lang.Object
jakarta.enterprise.util.AnnotationLiteral
jakarta.faces.event.WebsocketEvent.Opened.Literal

All Implemented Interfaces

jakarta.faces.event.WebsocketEvent.Opened, java.lang.annotation.Annotation

Supports inline instantiation of the Opened qualifier.

Since: 4.0

Field Summary

Modifier and Type	Field and Description
public static final WebsocketEvent.Opened.Literal	INSTANCE Instance of the `Opened` qualifier.
private static final long	serialVersionUID Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	Literal()

Method Summary

Inherited from jakarta.enterprise.util.AnnotationLiteral:: annotationType equals hashCode toString

Field Detail

INSTANCE	back to summary
public static final WebsocketEvent.Opened.Literal INSTANCE Instance of the `Opened` qualifier.

serialVersionUID	back to summary
private static final long serialVersionUID Hides jakarta.enterprise.util.AnnotationLiteral.serialVersionUID.

Constructor Detail

Literal	back to summary
public Literal()