Package io.undertow.websockets

Class EncodingFactory

java.lang.Object

io.undertow.websockets.EncodingFactory

public class EncodingFactory
extends Object

Factory class that produces encoding instances for an endpoint. This also provides static methods about the capabilities of encoders.

These classes also perform implicit encodings for java primitives

Author:

Stuart Douglas

Field Summary

Fields

Modifier and Type	Field	Description
static final EncodingFactory	DEFAULT	An encoding factory that can deal with primitive types.

Constructor Summary

Constructors

Constructor	Description
EncodingFactory(Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Encoder>>> binaryEncoders, Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Decoder>>> binaryDecoders, Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Encoder>>> textEncoders, Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Decoder>>> textDecoders)

Method Summary

Modifier and Type	Method	Description
boolean	canDecodeBinary(Class<?> type)
boolean	canDecodeText(Class<?> type)
boolean	canEncodeBinary(Class<?> type)
boolean	canEncodeText(Class<?> type)
Encoding	createEncoding(jakarta.websocket.EndpointConfig endpointConfig)
static EncodingFactory	createFactory(ObjectIntrospecter objectIntrospecter, Class<? extends jakarta.websocket.Decoder>[] decoders, Class<? extends jakarta.websocket.Encoder>[] encoders)
static EncodingFactory	createFactory(ObjectIntrospecter objectIntrospecter, List<Class<? extends jakarta.websocket.Decoder>> decoders, List<Class<? extends jakarta.websocket.Encoder>> encoders)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final EncodingFactory DEFAULT

An encoding factory that can deal with primitive types.

Constructor Details

EncodingFactory

public EncodingFactory(Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Encoder>>> binaryEncoders,
 Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Decoder>>> binaryDecoders,
 Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Encoder>>> textEncoders,
 Map<Class<?>,List<ObjectFactory<? extends jakarta.websocket.Decoder>>> textDecoders)

Method Details

canEncodeText

public boolean canEncodeText(Class<?> type)

canDecodeText

public boolean canDecodeText(Class<?> type)

canEncodeBinary

public boolean canEncodeBinary(Class<?> type)

canDecodeBinary

public boolean canDecodeBinary(Class<?> type)

createEncoding

public Encoding createEncoding(jakarta.websocket.EndpointConfig endpointConfig)

createFactory

public static EncodingFactory createFactory(ObjectIntrospecter objectIntrospecter,
 Class<? extends jakarta.websocket.Decoder>[] decoders,
 Class<? extends jakarta.websocket.Encoder>[] encoders)
                                     throws jakarta.websocket.DeploymentException

Throws:

jakarta.websocket.DeploymentException

createFactory

public static EncodingFactory createFactory(ObjectIntrospecter objectIntrospecter,
 List<Class<? extends jakarta.websocket.Decoder>> decoders,
 List<Class<? extends jakarta.websocket.Encoder>> encoders)
                                     throws jakarta.websocket.DeploymentException

Throws:

jakarta.websocket.DeploymentException