JsrParamIdOnOpen (Jetty :: Project 9.4.56.v20240826 API)

java.lang.Object
- org.eclipse.jetty.websocket.jsr356.annotations.JsrParamIdBase
- - org.eclipse.jetty.websocket.jsr356.annotations.JsrParamIdOnOpen

All Implemented Interfaces:: IJsrParamId

public class JsrParamIdOnOpen
extends JsrParamIdBase
implements IJsrParamId

Param handling for @OnOpen parameters.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static IJsrParamId INSTANCE
- Constructor Summary
  
  Constructors
  Constructor Description
  
  JsrParamIdOnOpen()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean process(Param param, JsrCallable callable)
  Process the potential parameter.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final IJsrParamId INSTANCE
```
- Constructor Detail
  - JsrParamIdOnOpen
```
public JsrParamIdOnOpen()
```
- Method Detail
  - process
```
public boolean process(Param param,
                       JsrCallable callable)
                throws InvalidSignatureException
```
    Description copied from interface: IJsrParamId
    
    Process the potential parameter.
    If known to be a valid parameter, bind a role to it.
    
    Specified by:
    
    process in interface IJsrParamId
    
    Overrides:
    
    process in class JsrParamIdBase
    
    Parameters:
    
    param - the parameter being processed
    
    callable - the callable this param belongs to (used to obtain extra state about the callable that might impact decision making)
    
    Returns:
    
    true if processed, false if not processed
    
    Throws:
    
    InvalidSignatureException - if a violation of the signature rules occurred