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

Enum AuthStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuthStatus>
    public enum AuthStatus
extends java.lang.Enum<AuthStatus>
    the authentication states that a RemoteMenuController can be in. Internally, the controller object is always in one of these states, and this is just the exterior view of the state.

    • Enum Constant Detail

      • AWAITING_CONNECTION

        public static final AuthStatus AWAITING_CONNECTION

      • AWAITING_JOIN

        public static final AuthStatus AWAITING_JOIN

      • SENT_JOIN

        public static final AuthStatus SENT_JOIN

      • AUTHENTICATED

        public static final AuthStatus AUTHENTICATED

      • FAILED_AUTH

        public static final AuthStatus FAILED_AUTH

    • Method Detail

      • values

        public static AuthStatus[] 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 (AuthStatus c : AuthStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AuthStatus 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()