org.eclipse.jetty.websocket.jsr356.client

Class JsrClientEndpointImpl

java.lang.Object

org.eclipse.jetty.websocket.jsr356.client.JsrClientEndpointImpl

All Implemented Interfaces:

EventDriverImpl

public class JsrClientEndpointImpl
extends java.lang.Object
implements EventDriverImpl

Event Driver for classes annotated with @ClientEndpoint

Constructor Summary

Constructors

Constructor and Description
JsrClientEndpointImpl()

Method Summary

Modifier and Type	Method and Description
EventDriver	create(java.lang.Object websocket, WebSocketPolicy policy) Create the EventDriver based on this implementation.
java.lang.String	describeRule() human readable string describing the rule that would support this EventDriver.
boolean	supports(java.lang.Object websocket) Test for if this implementation can support the provided websocket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsrClientEndpointImpl

public JsrClientEndpointImpl()

Method Detail

create

public EventDriver create(java.lang.Object websocket,
                          WebSocketPolicy policy)
                   throws javax.websocket.DeploymentException

Description copied from interface: EventDriverImpl

Create the EventDriver based on this implementation.

Specified by:

create in interface EventDriverImpl

Parameters:

websocket - the websocket to wrap

policy - the policy to use

Returns:

the created EventDriver

Throws:

javax.websocket.DeploymentException

describeRule

public java.lang.String describeRule()

Description copied from interface: EventDriverImpl

human readable string describing the rule that would support this EventDriver.

Used to help developer with possible object annotations, listeners, or base classes.

Specified by:

describeRule in interface EventDriverImpl

Returns:

the human readable description of this event driver rule(s).

supports

public boolean supports(java.lang.Object websocket)

Description copied from interface: EventDriverImpl

Test for if this implementation can support the provided websocket.

Specified by:

supports in interface EventDriverImpl

Parameters:

websocket - the possible websocket to test

Returns:

true if implementation can support it, false if otherwise.