Enum Status

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Status>

    public enum Status
    extends java.lang.Enum<Status>
    Mapping of HTTP response codes to a constant 'success' or 'failure' value.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILURE
      Any status code >= 400 and < 1000
      SUCCESS
      Any status code >= 100 and < 400
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int max  
      private int min  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Status​(int min, int max)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Status find​(int code)
      Find the Status value that matches the given status code.
      boolean matches​(int code)
      Returns true if the numeric code matches the represented status (either success or failure).
      java.lang.String toString()  
      static Status valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Status[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SUCCESS

        public static final Status SUCCESS
        Any status code >= 100 and < 400
      • FAILURE

        public static final Status FAILURE
        Any status code >= 400 and < 1000
    • Field Detail

      • min

        private final int min
      • max

        private final int max
    • Constructor Detail

      • Status

        private Status​(int min,
                       int max)
    • Method Detail

      • values

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

        public static Status 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Status>
      • matches

        public boolean matches​(int code)
        Returns true if the numeric code matches the represented status (either success or failure). i.e.
         assert Status.SUCCESS.matches(200);
         assert Status.FAILURE.matches(404);
         
        Parameters:
        code - numeric HTTP code
        Returns:
        true if the numeric code represents this enums success or failure condition
      • find

        public static Status find​(int code)
        Find the Status value that matches the given status code.
        Parameters:
        code - HTTP response code
        Returns:
        a 'success' or 'failure' Status value
        Throws:
        java.lang.IllegalArgumentException - if the given code is not a valid HTTP status code.