Package org.eclipse.jetty.websocket.jsr356.annotations

Interface IJsrMethod

public interface IJsrMethod

Method Summary

Modifier and Type	Method	Description
void	enablePartialMessageSupport()	Indicate that partial message support is desired
java.lang.String	getFullyQualifiedMethodName()	Get the fully qualifed method name {classname}.{methodname}({params}) suitable for using in error messages.
java.lang.Class<? extends Decoder>	getMessageDecoder()	Get the Decoder to use for message decoding
MessageType	getMessageType()	The type of message this method can handle
java.lang.reflect.Method	getMethod()	The reflected method
boolean	isPartialMessageSupportEnabled()	Indicator that partial message support is enabled
void	setMessageDecoder(java.lang.Class<? extends Decoder> decoderClass)	The message decoder class to use.
void	setMessageType(MessageType type)	The type of message this method can handle

Method Detail

enablePartialMessageSupport

void enablePartialMessageSupport()

Indicate that partial message support is desired

getFullyQualifiedMethodName

java.lang.String getFullyQualifiedMethodName()

Get the fully qualifed method name {classname}.{methodname}({params}) suitable for using in error messages.

Returns:

the fully qualified method name for end users

getMessageDecoder

java.lang.Class<? extends Decoder> getMessageDecoder()

Get the Decoder to use for message decoding

Returns:

the decoder class to use for message decoding

getMessageType

MessageType getMessageType()

The type of message this method can handle

Returns:

the message type if @OnMessage annotated, null if unknown/unspecified

getMethod

java.lang.reflect.Method getMethod()

The reflected method

Returns:

the method itself

isPartialMessageSupportEnabled

boolean isPartialMessageSupportEnabled()

Indicator that partial message support is enabled

Returns:

true if enabled

setMessageDecoder

void setMessageDecoder(java.lang.Class<? extends Decoder> decoderClass)

The message decoder class to use.

Parameters:

decoderClass - the Decoder implementation to use

setMessageType

void setMessageType(MessageType type)

The type of message this method can handle

Parameters:

type - the type of message