Package org.restlet.engine.application

Class StatusInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class StatusInfo
extends java.lang.Object
implements java.io.Serializable
    Representation of a Status.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int code
      The specification code.
      private java.lang.String contactEmail
      The email address of the administrator to contact in case of error.
      private java.lang.String description
      The longer description.
      private java.lang.String homeRef
      The home URI to propose in case of error.
      private java.lang.String reasonPhrase
      The short reason phrase.
      private static long serialVersionUID  
      private java.lang.String uri
      The URI of the specification describing the method.

    • Constructor Summary

      Constructors 
      Constructor Description
      StatusInfo()
      Empty Constructor
      StatusInfo​(int code, java.lang.String description, java.lang.String reasonPhrase)
      Constructor.
      StatusInfo​(int code, java.lang.String description, java.lang.String reasonPhrase, java.lang.String uri, java.lang.String contactEmail, java.lang.String homeRef)
      Constructor.
      StatusInfo​(Status status)
      Constructor.
      StatusInfo​(Status status, java.lang.String contactEmail, java.lang.String homeRef)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getCode()
      Returns the code of the status.
      java.lang.String getContactEmail()
      Returns the email address of the administrator to contact in case of error.
      java.lang.String getDescription()
      Returns the description of the status.
      java.lang.String getHomeRef()
      Returns the home URI to propose in case of error.
      java.lang.String getReasonPhrase()
      Returns the short description of the status.
      java.lang.String getUri()
      Returns the URI of the specification describing the status.
      void setCode​(int code)
      Sets the code of the status.
      void setContactEmail​(java.lang.String email)
      Sets the email address of the administrator to contact in case of error.
      void setDescription​(java.lang.String description)
      Sets the description of the status.
      void setHomeRef​(java.lang.String homeRef)
      Sets the home URI to propose in case of error.
      void setReasonPhrase​(java.lang.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

    • Field Detail

      • code

        private volatile int code
        The specification code.

      • contactEmail

        private volatile java.lang.String contactEmail
        The email address of the administrator to contact in case of error.

      • description

        private volatile java.lang.String description
        The longer description.

      • homeRef

        private volatile java.lang.String homeRef
        The home URI to propose in case of error.

      • reasonPhrase

        private volatile java.lang.String reasonPhrase
        The short reason phrase.

      • uri

        private volatile java.lang.String uri
        The URI of the specification describing the method.

    • Constructor Detail

      • StatusInfo

        public StatusInfo()
        Empty Constructor

      • StatusInfo

        public StatusInfo​(int code,
                  java.lang.String description,
                  java.lang.String reasonPhrase)
        Constructor.
        Parameters:
        code - The specification code.
        description - The longer description.
        reasonPhrase - The short reason phrase.

      • StatusInfo

        public StatusInfo​(int code,
                  java.lang.String description,
                  java.lang.String reasonPhrase,
                  java.lang.String uri,
                  java.lang.String contactEmail,
                  java.lang.String homeRef)
        Constructor.
        Parameters:
        code - The specification code.
        description - The longer description.
        reasonPhrase - The short reason phrase.
        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,
                  java.lang.String contactEmail,
                  java.lang.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 java.lang.String getContactEmail()
        Returns the email address of the administrator to contact in case of error.
        Returns:
        The email address.

      • getDescription

        public java.lang.String getDescription()
        Returns the description of the status.
        Returns:
        The description of the status.

      • getHomeRef

        public java.lang.String getHomeRef()
        Returns the home URI to propose in case of error.
        Returns:
        The home URI.

      • getReasonPhrase

        public java.lang.String getReasonPhrase()
        Returns the short description of the status.
        Returns:
        The short description of the status.

      • getUri

        public java.lang.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​(java.lang.String email)
        Sets the email address of the administrator to contact in case of error.
        Parameters:
        email - The email address.

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of the status.
        Parameters:
        description - The description of the status.

      • setHomeRef

        public void setHomeRef​(java.lang.String homeRef)
        Sets the home URI to propose in case of error.
        Parameters:
        homeRef - The home URI.

      • setReasonPhrase

        public void setReasonPhrase​(java.lang.String reasonPhrase)
        Sets the short description of the status.
        Parameters:
        reasonPhrase - The short description of the status.