Package io.undertow.websockets.jsr

Class EncodingFactory

  • public class EncodingFactory
extends java.lang.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 EncodingFactory DEFAULT
      An encoding factory that can deal with primitive types.

    • Constructor Summary

      Constructors 
      Constructor Description
      EncodingFactory​(java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Encoder>>> binaryEncoders, java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Decoder>>> binaryDecoders, java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Encoder>>> textEncoders, java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Decoder>>> textDecoders)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canDecodeBinary​(java.lang.Class<?> type)  
      boolean canDecodeText​(java.lang.Class<?> type)  
      boolean canEncodeBinary​(java.lang.Class<?> type)  
      boolean canEncodeText​(java.lang.Class<?> type)  
      Encoding createEncoding​(jakarta.websocket.EndpointConfig endpointConfig)  
      static EncodingFactory createFactory​(io.undertow.servlet.api.ClassIntrospecter classIntrospecter, java.lang.Class<? extends jakarta.websocket.Decoder>[] decoders, java.lang.Class<? extends jakarta.websocket.Encoder>[] encoders)  
      static EncodingFactory createFactory​(io.undertow.servlet.api.ClassIntrospecter classIntrospecter, java.util.List<java.lang.Class<? extends jakarta.websocket.Decoder>> decoders, java.util.List<java.lang.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 Detail

      • DEFAULT

        public static final EncodingFactory DEFAULT
        An encoding factory that can deal with primitive types.

    • Constructor Detail

      • EncodingFactory

        public EncodingFactory​(java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Encoder>>> binaryEncoders,
                       java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Decoder>>> binaryDecoders,
                       java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Encoder>>> textEncoders,
                       java.util.Map<java.lang.Class<?>,​java.util.List<io.undertow.servlet.api.InstanceFactory<? extends jakarta.websocket.Decoder>>> textDecoders)

    • Method Detail

      • canEncodeText

        public boolean canEncodeText​(java.lang.Class<?> type)

      • canDecodeText

        public boolean canDecodeText​(java.lang.Class<?> type)

      • canEncodeBinary

        public boolean canEncodeBinary​(java.lang.Class<?> type)

      • canDecodeBinary

        public boolean canDecodeBinary​(java.lang.Class<?> type)

      • createEncoding

        public Encoding createEncoding​(jakarta.websocket.EndpointConfig endpointConfig)

      • createFactory

        public static EncodingFactory createFactory​(io.undertow.servlet.api.ClassIntrospecter classIntrospecter,
                                            java.lang.Class<? extends jakarta.websocket.Decoder>[] decoders,
                                            java.lang.Class<? extends jakarta.websocket.Encoder>[] encoders)
                                     throws jakarta.websocket.DeploymentException
        Throws:
        jakarta.websocket.DeploymentException

      • createFactory

        public static EncodingFactory createFactory​(io.undertow.servlet.api.ClassIntrospecter classIntrospecter,
                                            java.util.List<java.lang.Class<? extends jakarta.websocket.Decoder>> decoders,
                                            java.util.List<java.lang.Class<? extends jakarta.websocket.Encoder>> encoders)
                                     throws jakarta.websocket.DeploymentException
        Throws:
        jakarta.websocket.DeploymentException