Top Inners Fields Constructors Methods
io.undertow.websockets

public Class WebSocketExtension

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Collections, .Iterator, .List
Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WebSocketExtension.Parameter

Field Summary

Modifier and TypeField and Description
private final String
name

private final List<WebSocketExtension.Parameter>
parameters

Constructor Summary

AccessConstructor and Description
public
WebSocketExtension(String name)

public
WebSocketExtension(String name, List<WebSocketExtension.Parameter> parameters)

Method Summary

Modifier and TypeMethod and Description
public String
getName()

public List<WebSocketExtension.Parameter>
getParameters()

public static List<WebSocketExtension>
parse(final String extensionHeader)

public static String

Returns:

a string representation of the extensions
toExtensionHeader(final List<WebSocketExtension>
list of WebSocketExtension
extensions)

Compose a String from a list of extensions to be used in the response of a protocol negotiation.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
parametersback to summary
private final List<WebSocketExtension.Parameter> parameters

Constructor Detail

WebSocketExtensionback to summary
public WebSocketExtension(String name)
WebSocketExtensionback to summary
public WebSocketExtension(String name, List<WebSocketExtension.Parameter> parameters)

Method Detail

getNameback to summary
public String getName()
getParametersback to summary
public List<WebSocketExtension.Parameter> getParameters()
parseback to summary
public static List<WebSocketExtension> parse(final String extensionHeader)
toExtensionHeaderback to summary
public static String toExtensionHeader(final List<WebSocketExtension> extensions)

Compose a String from a list of extensions to be used in the response of a protocol negotiation.

Parameters
extensions:List<WebSocketExtension>

list of WebSocketExtension

Returns:String

a string representation of the extensions

See Also
io.undertow.util.Headers
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
io.undertow.websockets back to summary

public final Class WebSocketExtension.Parameter

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final String
name

private final String
value

Constructor Summary

AccessConstructor and Description
public
Parameter(String name, String value)

Method Summary

Modifier and TypeMethod and Description
public String
getName()

public String
getValue()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
valueback to summary
private final String value

Constructor Detail

Parameterback to summary
public Parameter(String name, String value)

Method Detail

getNameback to summary
public String getName()
getValueback to summary
public String getValue()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override