org.jooby

Class WebSocket.Definition

java.lang.Object

org.jooby.WebSocket.Definition

Enclosing interface:

WebSocket

public static class WebSocket.Definition
extends Object

Configure a web socket.

Since:

0.1.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Definition(String pattern, WebSocket.OnOpen handler) Creates a new WebSocket.Definition.

Method Summary

Modifier and Type	Method and Description
MediaType	consumes()
WebSocket.Definition	consumes(MediaType type) Set the media types the route can consume.
WebSocket.Definition	consumes(String type) Set the media types the route can consume.
boolean	equals(Object obj)
int	hashCode()
Optional<WebSocket>	matches(String path) Test if the given path matches this web socket.
String	pattern()
MediaType	produces()
WebSocket.Definition	produces(MediaType type) Set the media types the route can produces.
WebSocket.Definition	produces(String type) Set the media types the route can produces.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Definition

public Definition(String pattern,
                  WebSocket.OnOpen handler)

Creates a new WebSocket.Definition.

Parameters:

pattern - A path pattern.

handler - A ws handler.

Method Detail

pattern

public String pattern()

Returns:

A route pattern.

matches

public Optional<WebSocket> matches(String path)

Test if the given path matches this web socket.

Parameters:

path - A path pattern.

Returns:

A web socket or empty optional.

consumes

public WebSocket.Definition consumes(String type)

Set the media types the route can consume.

Parameters:

type - The media types to test for.

Returns:

This route definition.

consumes

public WebSocket.Definition consumes(MediaType type)

Set the media types the route can consume.

Parameters:

type - The media types to test for.

Returns:

This route definition.

produces

public WebSocket.Definition produces(String type)

Set the media types the route can produces.

Parameters:

type - The media types to test for.

Returns:

This route definition.

produces

public WebSocket.Definition produces(MediaType type)

Set the media types the route can produces.

Parameters:

type - The media types to test for.

Returns:

This route definition.

consumes

public MediaType consumes()

Returns:

All the types this route can consumes.

produces

public MediaType produces()

Returns:

All the types this route can produces.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object