com.github.wuic.servlet

Enum HttpUtil

java.lang.Object

java.lang.Enum<HttpUtil>

com.github.wuic.servlet.HttpUtil

All Implemented Interfaces:

Serializable, Comparable<HttpUtil>

public enum HttpUtil
extends Enum<HttpUtil>

Tool that can be used to deal with an HTTP request state to know if GZIP is supported and then write according to this information a ConvertibleNut to the HTTP response.

Since:

0.5.0

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGzip(HttpServletRequest request) Indicates if the given HttpServletRequest supports GZIP or not.
static HttpUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	write(ConvertibleNut nut, HttpServletResponse response) Serves the given nut by changing the specified response's state.

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

INSTANCE

public static final HttpUtil INSTANCE

Singleton.

Method Detail

values

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

Returns:

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

valueOf

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

canGzip

public boolean canGzip(HttpServletRequest request)

Indicates if the given HttpServletRequest supports GZIP or not.

Parameters:

request - the request indicating GZIP support

Returns:

true if GZIP is supported, false otherwise

write

public void write(ConvertibleNut nut,
         HttpServletResponse response)
           throws IOException

Serves the given nut by changing the specified response's state. The method sets headers and writes response.

Parameters:

nut - the nut to write

response - the response

Throws:

IOException - if stream could not be opened