Enum Status

java.lang.Object
java.lang.Enum<Status>
groovyx.net.http.Status
All Implemented Interfaces:
Serializable, Comparable<Status>

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

    Enum Constants
    Enum Constant
    Description
    Any status code >= 400 and invalid input: '<' 1000
    Any status code >= 100 and invalid input: '<' 400
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
     
    private final int
     
  • Constructor Summary

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

    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).
     
    static Status
    Returns the enum constant of this type with the specified name.
    static Status[]
    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 Details

    • SUCCESS

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

      public static final Status FAILURE
      Any status code >= 400 and invalid input: '<' 1000
  • Field Details

    • min

      private final int min
    • max

      private final int max
  • Constructor Details

    • Status

      private Status(int min, int max)
  • Method Details

    • values

      public static Status[] 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 Status valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class 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:
      IllegalArgumentException - if the given code is not a valid HTTP status code.