Class MessageHandlerMetadata


  • public class MessageHandlerMetadata
    extends java.lang.Object
    An immutable metadata for a MessageHandler, representing a single interface on a message handling class.

    A message handling class can contain more than 1 valid MessageHandler interface, this will result in multiple MessageHandlerMetadata instances, each tracking one of the MessageHandler interfaces declared.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Class<? extends javax.websocket.MessageHandler> handlerClass
      The implemented MessageHandler class.
      private boolean isPartialSupported
      Indicator if this is a MessageHandler.Partial or MessageHandler.Whole interface.
      private java.lang.Class<?> messageClass
      The class type that this specific interface's generic implements.
    • Constructor Summary

      Constructors 
      Constructor Description
      MessageHandlerMetadata​(java.lang.Class<? extends javax.websocket.MessageHandler> handlerClass, java.lang.Class<?> messageClass, boolean partial)  
    • Field Detail

      • handlerClass

        private final java.lang.Class<? extends javax.websocket.MessageHandler> handlerClass
        The implemented MessageHandler class.

        Commonly a end-user provided class, with 1 or more implemented MessageHandler interfaces

      • isPartialSupported

        private final boolean isPartialSupported
        Indicator if this is a MessageHandler.Partial or MessageHandler.Whole interface.

        True for MessageHandler.Partial, other wise its a MessageHandler.Whole

      • messageClass

        private final java.lang.Class<?> messageClass
        The class type that this specific interface's generic implements.

        Or said another way, the first parameter type on this interface's onMessage() method.

    • Constructor Detail

      • MessageHandlerMetadata

        public MessageHandlerMetadata​(java.lang.Class<? extends javax.websocket.MessageHandler> handlerClass,
                                      java.lang.Class<?> messageClass,
                                      boolean partial)
    • Method Detail

      • getHandlerClass

        public java.lang.Class<? extends javax.websocket.MessageHandler> getHandlerClass()
      • getMessageClass

        public java.lang.Class<?> getMessageClass()
      • isPartialSupported

        public boolean isPartialSupported()