/*
    * Copyright 2012 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.ci.comm.command;
  
  import java.io.Serializable;
  
  /**
   * The result of the execution of a {@link Command}.
   *
   * @param <T> the type of the command this is a result for.
   */
  public final class CommandResult<T extends Command<T>> implements Serializable
  {
  
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The return code.
     *
     * @serial
     */
    private final int code;
  
    /**
     * The information about the HTTP status returned by the result.
     *
     * @serial
     */
    private final HttpStatus httpStatus;
  
    /**
     * The page returned on the request. Since this may be a performance issue,
     * this information is not collected by default. Therefore the value may be
     * <code>null</code>.
     *
     * @serial
     */
    private final String pageContent;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param code the return code.
     * @param httpStatus the information about the HTTP status returned by the
     *          result.
     * @param pageContent the page returned on the request.
     */
    public CommandResult(final int code, final HttpStatus httpStatus,
        final String pageContent)
    {
      this.code = code;
      this.httpStatus = httpStatus;
      this.pageContent = pageContent;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Provides information about the HTTP status returned by the result.
     */
    public static final class HttpStatus implements Serializable
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      /**
       * The class version identifier.
       * <p>
       * The value of this constant is {@value}.
      * </p>
      */
     private static final long serialVersionUID = 1L;
 
     /**
      * HTTP-status OK.
      */
     public static final int OK = 200;
 
     // --- members ------------------------------------------------------------
 
     /**
      * The HTTP status code of the result.
      *
      * @serial
      */
     private final int code;
 
     /**
      * The HTTP status text of the result.
      *
      * @serial
      */
     private final String text;
 
     // ***************************** Initializer ******************************
 
     // ***************************** Constructors *****************************
 
     /**
      * Default constructor.
      *
      * @param code the HTTP status code of the result.
      * @param text the HTTP status text of the result.
      */
     public HttpStatus(final int code, final String text)
     {
       this.code = code;
       this.text = text;
     }
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Returns the HTTP status code of the result.
      *
      * @return the HTTP status code of the result.
      */
     public int getCode()
     {
       return code;
     }
 
     /**
      * Returns the HTTP status text of the result.
      *
      * @return the HTTP status text of the result.
      */
     public String getText()
     {
       return text;
     }
 
     // --- business -----------------------------------------------------------
 
     // --- object basics ------------------------------------------------------
 
     /**
      * {@inheritDoc}
      *
      * @see java.lang.Object#toString()
      */
     @Override
     public String toString()
     {
       return code + ": " + text;
     }
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the return code.
    *
    * @return the return code.
    */
   public int getCode()
   {
     return code;
   }
 
   /**
    * Returns the information about the HTTP status returned by the result.
    *
    * @return the information about the HTTP status returned by the result.
    */
   public HttpStatus getHttpStatus()
   {
     return httpStatus;
   }
 
   /**
    * Returns the page returned on the request. Since this may be a performance
    * issue, this information is not collected by default. Therefore the value
    * may be <code>null</code>.
    *
    * @return the page returned on the request.
    */
   public String getPageContent()
   {
     return pageContent;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see java.lang.Object#toString()
    */
   @Override
   public String toString()
   {
     return httpStatus + " (" + code + ')';
   }
 }