Record Class EncodedMessage

java.lang.Object
java.lang.Record
io.micronaut.servlet.websocket.EncodedMessage
Record Components:
text - The text payload, or null if this is a binary message
binary - The binary payload, or null if this is a text message
@Internal public record EncodedMessage(@Nullable String text, @Nullable ByteBuffer binary) extends Record
A message that has been encoded ready to be written to a Jakarta WebSocket remote endpoint, as either a text or a binary frame.
Since:
6.2.0
Author:
graemerocher

  • Constructor Details

    • EncodedMessage

      public EncodedMessage(@Nullable String text, @Nullable ByteBuffer binary)
      Creates an instance of a EncodedMessage record class.
      Parameters:
      text - the value for the text record component
      binary - the value for the binary record component

  • Method Details

    • ofText

      public static EncodedMessage ofText(String text)
      Creates a text message.
      Parameters:
      text - The text
      Returns:
      The message

    • ofBinary

      public static EncodedMessage ofBinary(ByteBuffer binary)
      Creates a binary message.
      Parameters:
      binary - The payload
      Returns:
      The message

    • isText

      public boolean isText()
      Returns:
      Whether this is a text message

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • text

      public @Nullable String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • binary

      public @Nullable ByteBuffer binary()
      Returns the value of the binary record component.
      Returns:
      the value of the binary record component