Module com.thecoderscorner.tcmenu.javaapi
Package com.thecoderscorner.menu.remote.commands

Enum AckStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AckStatus>
    public enum AckStatus
extends java.lang.Enum<AckStatus>
    An enumeration that represents all the possible status / error return codes from the remote.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()  
      int getStatusCode()  
      boolean isError()  
      static AckStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AckStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • 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 Detail

      • VALUE_RANGE_WARNING

        public static final AckStatus VALUE_RANGE_WARNING
        This is a warning that the value was out of range

      • SUCCESS

        public static final AckStatus SUCCESS
        The operation was successful

      • ID_NOT_FOUND

        public static final AckStatus ID_NOT_FOUND
        The requested ID was not found

      • INVALID_CREDENTIALS

        public static final AckStatus INVALID_CREDENTIALS
        The credentials provided were incorrect

      • UNKNOWN_ERROR

        public static final AckStatus UNKNOWN_ERROR
        There was an error that is not categorised.

    • Method Detail

      • values

        public static AckStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AckStatus c : AckStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AckStatus 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

      • getDescription

        public java.lang.String getDescription()
        Returns:
        description of this status

      • getStatusCode

        public int getStatusCode()
        Returns:
        the integer wire code for this status.

      • isError

        public boolean isError()
        Returns:
        true if the status code is an error, otherwise false.