org.dmfs.httpessentials.status

Class SimpleHttpStatus

java.lang.Object

org.dmfs.httpessentials.status.SimpleHttpStatus

All Implemented Interfaces:

HttpStatus

public final class SimpleHttpStatus
extends java.lang.Object
implements HttpStatus

Simple implementation of an HttpStatus.

Author:

Marten Gajda

Field Summary

Fields inherited from interface org.dmfs.httpessentials.HttpStatus

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, LOCKED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTIPLE_CHOICES, MULTISTATUS, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NONE, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, UNAUTHORIZED, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES

Constructor Summary

Constructors

Constructor and Description
SimpleHttpStatus(int statusCode, java.lang.String reasonPhrase) Initialize an HttpStatus object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	httpStatusLine(int httpVersionMajor, int httpVersionMinor) Returns a status line in the form: HTTP/VersionMajor.VersionMinor SP Status-Code SP Reason-Phrase
boolean	isClientError() Returns whether this status represents a client error status code.
boolean	isInformational() Returns whether this represents an informational status code.
boolean	isRedirect() Returns whether this status represents a redirection status code.
boolean	isServerError() Returns whether this status represents a server error status code.
boolean	isSuccess() Returns whether this status represents a success status code.
java.lang.String	reason() Returns the reason phrase of this status code.
int	statusCode() Returns the status code.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleHttpStatus

public SimpleHttpStatus(int statusCode,
                java.lang.String reasonPhrase)

Initialize an HttpStatus object.

Parameters:

statusCode - The status code.

reasonPhrase - The reason phrase of this status.

Method Detail

statusCode

public int statusCode()

Description copied from interface: HttpStatus

Returns the status code.

Specified by:

statusCode in interface HttpStatus

Returns:

reason

public java.lang.String reason()

Description copied from interface: HttpStatus

Returns the reason phrase of this status code.

Note: the reason phrase doesn't contain the status code itself.

Specified by:

reason in interface HttpStatus

Returns:

The reason phrase or null if the status code is unknown.

httpStatusLine

public java.lang.String httpStatusLine(int httpVersionMajor,
                              int httpVersionMinor)

Description copied from interface: HttpStatus

Returns a status line in the form:

 HTTP/VersionMajor.VersionMinor SP Status-Code SP Reason-Phrase
 

Specified by:

httpStatusLine in interface HttpStatus

Parameters:

httpVersionMajor - The major version number, usually 1

httpVersionMinor - The minor version number, usually 1

Returns:

isInformational

public boolean isInformational()

Description copied from interface: HttpStatus

Returns whether this represents an informational status code.

Specified by:

isInformational in interface HttpStatus

Returns:

true if this represents an informational status code, false otherwise.

isSuccess

public boolean isSuccess()

Description copied from interface: HttpStatus

Returns whether this status represents a success status code.

Specified by:

isSuccess in interface HttpStatus

Returns:

true if this represents a success status code, false otherwise.

isRedirect

public boolean isRedirect()

Description copied from interface: HttpStatus

Returns whether this status represents a redirection status code.

Specified by:

isRedirect in interface HttpStatus

Returns:

true if this represents a redirection status code, false otherwise.

isClientError

public boolean isClientError()

Description copied from interface: HttpStatus

Returns whether this status represents a client error status code.

Specified by:

isClientError in interface HttpStatus

Returns:

true if this represents a client error status code, false otherwise.

isServerError

public boolean isServerError()

Description copied from interface: HttpStatus

Returns whether this status represents a server error status code.

Specified by:

isServerError in interface HttpStatus

Returns:

true if this represents a server error status code, false otherwise.

hashCode

public int hashCode()

Specified by:

hashCode in interface HttpStatus

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface HttpStatus

Overrides:

equals in class java.lang.Object