org.safs.net

Enum IHttpRequest.Key

java.lang.Object

java.lang.Enum<IHttpRequest.Key>

org.safs.net.IHttpRequest.Key

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IHttpRequest.Key>

Enclosing interface:

IHttpRequest

public static enum IHttpRequest.Key
extends java.lang.Enum<IHttpRequest.Key>

The enumeration represents some of XMLHttpRequest Object Properties, such as "status", "statusText", "responseText" etc. and some other strings like "responseHeaders", "requestHeaders".
They will be used as keys in Map result returned by IHttpRequest.execute(HttpCommand, String, boolean, Map, String).
The enumeration has a method value(), which can return the string format.

Enum Constant Summary

Enum Constants

Enum Constant and Description
READY_STATE 'readyState'
REQUEST_HEADERS 'requestHeaders' the HTTP request headers as a string
RESPONSE_HEADERS 'responseHeaders' the HTTP response headers as a string
RESPONSE_STATUS 'status' the status-number (e.g.
RESPONSE_STATUS_TEXT 'statusText' the status-text (e.g.
RESPONSE_TEXT 'responseText' the HTTP response data as a string
RESPONSE_XML 'responseXML' the HTTP response data as XML data

Method Summary

Modifier and Type	Method and Description
java.lang.String	value() getter of value
static IHttpRequest.Key	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IHttpRequest.Key[]	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

READY_STATE

public static final IHttpRequest.Key READY_STATE

'readyState'

 
 Holds the status of the XMLHttpRequest. Changes from 0 to 4:
 0: request not initialized
 1: server connection established
 2: request received
 3: processing request
 4: request finished and response is ready
 

See Also:

XMLHttpRequest.AjaxReadyState

RESPONSE_TEXT

public static final IHttpRequest.Key RESPONSE_TEXT

'responseText' the HTTP response data as a string

RESPONSE_XML

public static final IHttpRequest.Key RESPONSE_XML

'responseXML' the HTTP response data as XML data

RESPONSE_STATUS

public static final IHttpRequest.Key RESPONSE_STATUS

'status' the status-number (e.g. "404" for "Not Found" or "200" for "OK")

See Also:

org.safs.net.HttpRequest.HttpResponseStatus

RESPONSE_STATUS_TEXT

public static final IHttpRequest.Key RESPONSE_STATUS_TEXT

'statusText' the status-text (e.g. "Not Found" or "OK")

RESPONSE_HEADERS

public static final IHttpRequest.Key RESPONSE_HEADERS

'responseHeaders' the HTTP response headers as a string

REQUEST_HEADERS

public static final IHttpRequest.Key REQUEST_HEADERS

'requestHeaders' the HTTP request headers as a string

Method Detail

values

public static IHttpRequest.Key[] 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 (IHttpRequest.Key c : IHttpRequest.Key.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IHttpRequest.Key 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

value

public java.lang.String value()

getter of value