Param.Role (Jetty :: Websocket :: javax.websocket :: Client Implementation 9.4.12.v20180830 API)

java.lang.Object
- java.lang.Enum<Param.Role>
- - org.eclipse.jetty.websocket.jsr356.annotations.Param.Role

Enclosing class:: Param

public static enum Param.Role
extends java.lang.Enum<Param.Role>

The various roles of the known parameters.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CLOSE_REASON`
`ENDPOINT_CONFIG`
`ERROR_CAUSE`
`MESSAGE_BINARY`
`MESSAGE_BINARY_STREAM`
`MESSAGE_PARTIAL_FLAG`
`MESSAGE_PONG`
`MESSAGE_TEXT`
`MESSAGE_TEXT_STREAM`
`PATH_PARAM`
`SESSION`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Param.Role[]`	`getMessageRoles()`
`static Param.Role`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Param.Role[]`	`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
  - SESSION
```
public static final Param.Role SESSION
```
  - ENDPOINT_CONFIG
```
public static final Param.Role ENDPOINT_CONFIG
```
  - CLOSE_REASON
```
public static final Param.Role CLOSE_REASON
```
  - ERROR_CAUSE
```
public static final Param.Role ERROR_CAUSE
```
  - MESSAGE_TEXT
```
public static final Param.Role MESSAGE_TEXT
```
  - MESSAGE_TEXT_STREAM
```
public static final Param.Role MESSAGE_TEXT_STREAM
```
  - MESSAGE_BINARY
```
public static final Param.Role MESSAGE_BINARY
```
  - MESSAGE_BINARY_STREAM
```
public static final Param.Role MESSAGE_BINARY_STREAM
```
  - MESSAGE_PONG
```
public static final Param.Role MESSAGE_PONG
```
  - MESSAGE_PARTIAL_FLAG
```
public static final Param.Role MESSAGE_PARTIAL_FLAG
```
  - PATH_PARAM
```
public static final Param.Role PATH_PARAM
```
- Method Detail
  - values
```
public static Param.Role[] 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 (Param.Role c : Param.Role.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Param.Role valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getMessageRoles
```
public static Param.Role[] getMessageRoles()
```

Enum Param.Role

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SESSION

ENDPOINT_CONFIG

CLOSE_REASON

ERROR_CAUSE

MESSAGE_TEXT

MESSAGE_TEXT_STREAM

MESSAGE_BINARY

MESSAGE_BINARY_STREAM

MESSAGE_PONG

MESSAGE_PARTIAL_FLAG

PATH_PARAM

Method Detail

values

valueOf

getMessageRoles