Top Description Fields Constructors Methods
javax.websocket

pack-priv final Class DefaultClientEndpointConfig

extends Object
implements ClientEndpointConfig
Class Inheritance
All Implemented Interfaces
javax.websocket.ClientEndpointConfig, javax.websocket.EndpointConfig
Imports
java.util.Collections, .HashMap, .List, .Map
The DefaultClientEndpointConfig is a concrete implementation of a client configuration.
Author
dannycoward

Field Summary

Modifier and TypeField and Description
private ClientEndpointConfig.Configurator
clientEndpointConfigurator

private List<Class<? extends Decoder>>
decoders

private List<Class<? extends Encoder>>
encoders

private List<Extension>
extensions

private List<String>
preferredSubprotocols

private Map<String, Object>
userProperties

Constructor Summary

AccessConstructor and Description
pack-priv
DefaultClientEndpointConfig(List<String> preferredSubprotocols, List<Extension> extensions, List<Class<? extends Encoder>> encoders, List<Class<? extends Decoder>> decoders, ClientEndpointConfig.Configurator clientEndpointConfigurator)

Method Summary

Modifier and TypeMethod and Description
public ClientEndpointConfig.Configurator
getConfigurator()

Implements javax.websocket.ClientEndpointConfig.getConfigurator.

Return the custom configurator for this configuration.
public List<Class<? extends Decoder>>

Returns:

the decoders to use.
getDecoders()

Implements javax.websocket.EndpointConfig.getDecoders.

Return the (unmodifiable) list of decoders this client will use.
public List<Class<? extends Encoder>>

Returns:

the encoder list.
getEncoders()

Implements javax.websocket.EndpointConfig.getEncoders.

Return the (unmodifiable) list of encoders this client will use.
public List<Extension>

Returns:

the (unmodifiable) extension list.
getExtensions()

Implements javax.websocket.ClientEndpointConfig.getExtensions.

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.
public List<String>

Returns:

the preferred subprotocols.
getPreferredSubprotocols()

Implements javax.websocket.ClientEndpointConfig.getPreferredSubprotocols.

Return the protocols, in order of preference, favorite first, that this client would like to use for its sessions.
public final Map<String, Object>
getUserProperties()

Implements javax.websocket.EndpointConfig.getUserProperties.

Editable map of user properties.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientEndpointConfiguratorback to summary
private ClientEndpointConfig.Configurator clientEndpointConfigurator
decodersback to summary
private List<Class<? extends Decoder>> decoders
encodersback to summary
private List<Class<? extends Encoder>> encoders
extensionsback to summary
private List<Extension> extensions
preferredSubprotocolsback to summary
private List<String> preferredSubprotocols
userPropertiesback to summary
private Map<String, Object> userProperties

Constructor Detail

DefaultClientEndpointConfigback to summary
pack-priv DefaultClientEndpointConfig(List<String> preferredSubprotocols, List<Extension> extensions, List<Class<? extends Encoder>> encoders, List<Class<? extends Decoder>> decoders, ClientEndpointConfig.Configurator clientEndpointConfigurator)

Method Detail

getConfiguratorback to summary
public ClientEndpointConfig.Configurator getConfigurator()

Implements javax.websocket.ClientEndpointConfig.getConfigurator.

Doc from javax.websocket.ClientEndpointConfig.getConfigurator.

Return the custom configurator for this configuration. If the developer did not provide one, the platform default configurator is returned.

Returns:ClientEndpointConfig.Configurator

the configurator in use with this configuration.

Annotations
@Override
getDecodersback to summary
public List<Class<? extends Decoder>> getDecoders()

Implements javax.websocket.EndpointConfig.getDecoders.

Return the (unmodifiable) list of decoders this client will use.

Returns:List<Class<? extends Decoder>>

the decoders to use.

Annotations
@Override
getEncodersback to summary
public List<Class<? extends Encoder>> getEncoders()

Implements javax.websocket.EndpointConfig.getEncoders.

Return the (unmodifiable) list of encoders this client will use.

Returns:List<Class<? extends Encoder>>

the encoder list.

Annotations
@Override
getExtensionsback to summary
public List<Extension> getExtensions()

Implements javax.websocket.ClientEndpointConfig.getExtensions.

Return the extensions, in order of preference, favorite first, that this client would like to use for its sessions.

Returns:List<Extension>

the (unmodifiable) extension list.

Annotations
@Override
getPreferredSubprotocolsback to summary
public List<String> getPreferredSubprotocols()

Implements javax.websocket.ClientEndpointConfig.getPreferredSubprotocols.

Return the protocols, in order of preference, favorite first, that this client would like to use for its sessions.

Returns:List<String>

the preferred subprotocols.

Annotations
@Override
getUserPropertiesback to summary
public final Map<String, Object> getUserProperties()

Implements javax.websocket.EndpointConfig.getUserProperties.

Editable map of user properties.

Returns:Map<String, Object>

Doc from javax.websocket.EndpointConfig.getUserProperties.

a modifiable Map of application data.

Annotations
@Override