/*
    * $Header: /cvsroot/sinon/sinon/src/java/eteg/sinon/executor/PageState.java,v 1.2 2005/06/21 14:25:08 thiagohp Exp $
    * $Revision: 1.2 $
    * $Date: 2005/06/21 14:25:08 $
    * $Author: thiagohp $
    *
    * =============================================================================
    *
    * Copyright 2004-2005 Eteg Internet Ltda. (http://www.eteg.com.br)
   *
   * 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 eteg.sinon.executor;
  
  /***
   * Class that represents the state of processing of a page.
   *
   * @author <a href="mailto:thiagohp at users.sourceforge.net">Thiago H. de Paula Figueiredo</a>
   * @author Last modified by $Author: thiagohp $
   * @version $Revision: 1.2 $
   * @since 1.0
   */
  public class PageState {
  
      /***
       * Constant that defines the state of a page before its processing
       * begins.
       */
      final private static int BEFORE_DOWNLOAD_ID = 0;
  
      /***
       * Constant that defines the state of a page before its download.
       * begins.
       */
      final private static int BEFORE_PROCESSING_ID = 1;
  
      /***
       * Constant that defines the state of a page before after download and
       * processing.
       */
      final private static int AFTER_PROCESSING_ID = 2;
  
      /***
       * Constant that defines the state of a page before after all its actions
       * were executed.
       */
      final private static int FINISHED_ID = 3;
  
      /***
       * Constant that defines the state of a page before its processing
       * begins.
       */
      final public static PageState BEFORE_DOWNLOAD;
  
      /***
       * Constant that defines the state of a page before its download.
       * begins.
       */
      final public static PageState BEFORE_PROCESSING;
  
      /***
       * Constant that defines the state of a page before after download and
       * processing.
       */
      final public static PageState AFTER_PROCESSING;
  
      /***
       * Constant that defines the state of a page before after all its actions
       * were executed.
       */
      final public static PageState FINISHED;
  
      /***
       * Page state identifier.
       */
      private int stateId;
  
      static {
  
          BEFORE_DOWNLOAD = new PageState(BEFORE_DOWNLOAD_ID);
          BEFORE_PROCESSING = new PageState(BEFORE_PROCESSING_ID);
          AFTER_PROCESSING = new PageState(AFTER_PROCESSING_ID);
          FINISHED = new PageState(FINISHED_ID);
  
      }
  
      /***
       * Single constructor of this class. The valid values for
       * <code>stateId</code> are
      * {@link #BEFORE_DOWNLOAD_ID}, {@link #BEFORE_PROCESSING_ID},
      * {@link #AFTER_PROCESSING_ID}, and {@link #FINISHED_ID}.
      * @param stateId an <code>int</code>.
      * @throws java.lang.IllegalArgumentException if <code>stateId</code> is
      * not a valid value.
      */
     private PageState(int stateId) {
 
         if (stateId < BEFORE_DOWNLOAD_ID || stateId > FINISHED_ID) {
 
             throw new IllegalArgumentException(
                     "Parameter stateId does not have a valid value : " +
                     stateId);
 
         }
 
         this.stateId = stateId;
 
     }
 
     /***
      * Returns <code>true</code> if this state is
      * {@link #BEFORE_DOWNLOAD}.
      *
      * @return <code>true</code> if this state is
      * {@link #BEFORE_DOWNLOAD}, <code>false</code> otherwise.
      */
     public boolean isBeforeDownload() {
         return (stateId == BEFORE_DOWNLOAD_ID);
     }
 
     /***
      * Returns <code>true</code> if this state is
      * {@link #BEFORE_PROCESSING}.
      *
      * @return <code>true</code> if this state is
      * {@link #BEFORE_PROCESSING}, <code>false</code> otherwise.
      */
     public boolean isBeforeProcessing() {
         return (stateId == BEFORE_PROCESSING_ID);
     }
 
     /***
      * Returns <code>true</code> if this state is
      * {@link #AFTER_PROCESSING}.
      *
      * @return <code>true</code> if this state is
      * {@link #AFTER_PROCESSING}, <code>false</code> otherwise.
      */
     public boolean isAfterProcessing() {
         return (stateId == AFTER_PROCESSING_ID);
     }
 
     /***
      * Returns <code>true</code> if this state is
      * {@link #FINISHED}.
      *
      * @return <code>true</code> if this state is
      * {@link #BEFORE_DOWNLOAD}, <code>false</code> otherwise.
      */
     public boolean isFinished() {
         return (stateId == FINISHED_ID);
     }
 
     /***
      * Returns a <code>String</code> containing the name of this state.
      *
      * @return a <code>String</code>.
      */
     public String getStateName() {
 
         if (isBeforeDownload()) {
             return "before download";
         }
         else if (isBeforeProcessing()) {
             return "before processing";
         }
         else if (isAfterProcessing()) {
             return "after processing";
         }
         else if (isFinished()) {
             return "finished";
         }
         else {
             return "invalid page state";
         }
 
     }
 
     public boolean equals(final Object other) {
 
         if (other instanceof PageState == false) {
             return false;
         }
 
         PageState castOther = (PageState) other;
         return this.stateId == castOther.stateId;
 
     }
 
 }