com.mulesoft.connectors.ws.api

Enum BroadcastSocketType

java.lang.Object

java.lang.Enum<BroadcastSocketType>

com.mulesoft.connectors.ws.api.BroadcastSocketType

All Implemented Interfaces:

Serializable, Comparable<BroadcastSocketType>

public enum BroadcastSocketType
extends Enum<BroadcastSocketType>

Selects the type of WebSocket to be considered for a broadcast operation

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Matches all sockets regardless of its type
INBOUND Matches WebSocket.WebSocketType.INBOUND sockets
OUTBOUND Matches WebSocket.WebSocketType.OUTBOUND sockets

Method Summary

Modifier and Type	Method and Description
abstract Predicate<org.mule.runtime.http.api.ws.WebSocket>	asFilter()
static BroadcastSocketType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BroadcastSocketType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INBOUND

public static final BroadcastSocketType INBOUND

Matches WebSocket.WebSocketType.INBOUND sockets

OUTBOUND

public static final BroadcastSocketType OUTBOUND

Matches WebSocket.WebSocketType.OUTBOUND sockets

ALL

public static final BroadcastSocketType ALL

Matches all sockets regardless of its type

Method Detail

values

public static BroadcastSocketType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BroadcastSocketType c : BroadcastSocketType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BroadcastSocketType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

asFilter

public abstract Predicate<org.mule.runtime.http.api.ws.WebSocket> asFilter()

Returns:

a Predicate which matches sockets by type.