org.restlet.engine.application

Class StatusInfo

java.lang.Object

org.restlet.engine.application.StatusInfo

All Implemented Interfaces:

Serializable

public class StatusInfo
extends Object
implements Serializable

Representation of a Status.

Author:

Manuel Boillod

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusInfo() Empty Constructor
StatusInfo(int code, String description, String reasonPhrase) Constructor.
StatusInfo(int code, String description, String reasonPhrase, String uri, String contactEmail, String homeRef) Constructor.
StatusInfo(Status status) Constructor.
StatusInfo(Status status, String contactEmail, String homeRef) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the code of the status.
String	getContactEmail() Returns the email address of the administrator to contact in case of error.
String	getDescription() Returns the description of the status.
String	getHomeRef() Returns the home URI to propose in case of error.
String	getReasonPhrase() Returns the short description of the status.
String	getUri() Returns the URI of the specification describing the status.
void	setCode(int code) Sets the code of the status.
void	setContactEmail(String email) Sets the email address of the administrator to contact in case of error.
void	setDescription(String description) Sets the description of the status.
void	setHomeRef(String homeRef) Sets the home URI to propose in case of error.
void	setReasonPhrase(String reasonPhrase) Sets the short description of the status.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusInfo

public StatusInfo()

Empty Constructor

StatusInfo

public StatusInfo(int code,
                  String description,
                  String reasonPhrase)

Constructor.

Parameters:

code - The specification code.

description - The longer description.

reasonPhrase - The short reason phrase.

StatusInfo

public StatusInfo(int code,
                  String description,
                  String reasonPhrase,
                  String uri,
                  String contactEmail,
                  String homeRef)

Constructor.

Parameters:

code - The specification code.

description - The longer description.

reasonPhrase - The short reason phrase.

uri - The URI of the specification describing the method.

contactEmail - The email address of the administrator to contact in case of error.

homeRef - The home URI to propose in case of error.

StatusInfo

public StatusInfo(Status status)

Constructor.

Parameters:

status - The represented status.

StatusInfo

public StatusInfo(Status status,
                  String contactEmail,
                  String homeRef)

Constructor.

Parameters:

status - The represented status.

contactEmail - The email address of the administrator to contact in case of error.

homeRef - The home URI to propose in case of error.

Method Detail

getCode

public int getCode()

Returns the code of the status.

Returns:

The code of the status.

getContactEmail

public String getContactEmail()

Returns the email address of the administrator to contact in case of error.

Returns:

The email address.

getDescription

public String getDescription()

Returns the description of the status.

Returns:

The description of the status.

getHomeRef

public String getHomeRef()

Returns the home URI to propose in case of error.

Returns:

The home URI.

getReasonPhrase

public String getReasonPhrase()

Returns the short description of the status.

Returns:

The short description of the status.

getUri

public String getUri()

Returns the URI of the specification describing the status.

Returns:

The URI of the specification describing the status.

setCode

public void setCode(int code)

Sets the code of the status.

Parameters:

code - The code of the status.

setContactEmail

public void setContactEmail(String email)

Sets the email address of the administrator to contact in case of error.

Parameters:

email - The email address.

setDescription

public void setDescription(String description)

Sets the description of the status.

Parameters:

description - The description of the status.

setHomeRef

public void setHomeRef(String homeRef)

Sets the home URI to propose in case of error.

Parameters:

homeRef - The home URI.

setReasonPhrase

public void setReasonPhrase(String reasonPhrase)

Sets the short description of the status.

Parameters:

reasonPhrase - The short description of the status.