Enum RedisMessageType

java.lang.Object
java.lang.Enum<RedisMessageType>
io.netty.handler.codec.redis.RedisMessageType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RedisMessageType>
@UnstableApi public enum RedisMessageType extends java.lang.Enum<RedisMessageType>
Type of RESP (REdis Serialization Protocol).

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARRAY_HEADER
     
    BULK_STRING
     
    ERROR
     
    INLINE_COMMAND
     
    INTEGER
     
    SIMPLE_STRING
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final boolean
    inline
     
    private final java.lang.Byte
    value
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    RedisMessageType(java.lang.Byte value, boolean inline)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isInline()
    Returns true if this type is inline type, or returns false.
    int
    length()
    Returns length of this type.
    static RedisMessageType
    readFrom(ByteBuf in, boolean decodeInlineCommands)
    Determine RedisMessageType based on the type prefix byte read from given the buffer.
    private static RedisMessageType
    valueOf(byte value)
    Returns the enum constant of this type with the specified name.
    static RedisMessageType
    valueOf(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static RedisMessageType[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    void
    writeTo(ByteBuf out)
    Write the message type's prefix to the given buffer.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Field Details

    • value

      private final java.lang.Byte value

    • inline

      private final boolean inline

  • Constructor Details

    • RedisMessageType

      private RedisMessageType(java.lang.Byte value, boolean inline)

  • Method Details

    • values

      public static RedisMessageType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static RedisMessageType valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • length

      public int length()
      Returns length of this type.

    • isInline

      public boolean isInline()
      Returns true if this type is inline type, or returns false. If this is true, this type doesn't have length field.

    • readFrom

      public static RedisMessageType readFrom(ByteBuf in, boolean decodeInlineCommands)
      Determine RedisMessageType based on the type prefix byte read from given the buffer.

    • writeTo

      public void writeTo(ByteBuf out)
      Write the message type's prefix to the given buffer.

    • valueOf

      private static RedisMessageType valueOf(byte value)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null