DJDoc v.1.0.0b-1

net.sf.djdoc.servlet
Enum RequestType

java.lang.Object
  extended by java.lang.Enum<RequestType>
      extended by net.sf.djdoc.servlet.RequestType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RequestType>

public enum RequestType
extends java.lang.Enum<RequestType>

This enum is used to differentiate between different (in terms of business logic performed and/or output returned) types of HTTP requests.


Enum Constant Summary
API_LIST
          The API_LIST RequestType corresponds to all HTTP requests retrieving the list of all registered APIs.
BUNCH_LIST
          This RequestType corresponds to the HTTP requests retrieving a list of all packages for a registered API.
FILE
          The FILE RequestType is used for HTTP requests that simply copy the contents of a file into the response output stream.
ITEM_LIST
          The ITEM_LIST type is used for HTTP requests retrieving a list of all class items in a package of a registered API.
 
Method Summary
 Action getAction()
          Getter method for the Action instance of this RequestType.
static RequestType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RequestType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

API_LIST

public static final RequestType API_LIST
The API_LIST RequestType corresponds to all HTTP requests retrieving the list of all registered APIs.


BUNCH_LIST

public static final RequestType BUNCH_LIST
This RequestType corresponds to the HTTP requests retrieving a list of all packages for a registered API.


ITEM_LIST

public static final RequestType ITEM_LIST
The ITEM_LIST type is used for HTTP requests retrieving a list of all class items in a package of a registered API.


FILE

public static final RequestType FILE
The FILE RequestType is used for HTTP requests that simply copy the contents of a file into the response output stream.

Method Detail

values

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

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

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

getAction

public Action getAction()
Getter method for the Action instance of this RequestType.

Returns:
The Action instance corresponding to this RequestType

DJDoc v.1.0.0b-1