1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.logger;
    24  
    25  /**
    26   * Error report status.
    27   */
         /* 
    P/P   *  Method: ErrorReportStatus valueOf(String)
          * 
          *  Postconditions:
          *    init'ed(return_value)
          */
    28  public enum ErrorReportStatus {
    29      /** Not applicable. */
             /* 
    P/P       *  Method: com.dmdirc.logger.ErrorReportStatus__static_init
              * 
              *  Postconditions:
              *    $VALUES == &new ErrorReportStatus[](ErrorReportStatus__static_init#7)
              *    ERROR == &new ErrorReportStatus(ErrorReportStatus__static_init#4)
              *    $VALUES[3] == &new ErrorReportStatus(ErrorReportStatus__static_init#4)
              *    FINISHED == &new ErrorReportStatus(ErrorReportStatus__static_init#2)
              *    $VALUES[1] == &new ErrorReportStatus(ErrorReportStatus__static_init#2)
              *    NOT_APPLICABLE == &new ErrorReportStatus(ErrorReportStatus__static_init#1)
              *    $VALUES[0] == &new ErrorReportStatus(ErrorReportStatus__static_init#1)
              *    QUEUED == &new ErrorReportStatus(ErrorReportStatus__static_init#5)
              *    $VALUES[4] == &new ErrorReportStatus(ErrorReportStatus__static_init#5)
              *    SENDING == &new ErrorReportStatus(ErrorReportStatus__static_init#3)
              *    ...
              */
    30      NOT_APPLICABLE("Not applicable", true),
    31      /** Finished state. */
    32      FINISHED("Finished", true),
    33      /** Sending state. */
    34      SENDING("Sending...", false),
    35      /** Error sending. */
    36      ERROR("Error sending", true),
    37      /** Report queued. */
    38      QUEUED("Queued", false),
    39      /** Waiting state. */
    40      WAITING("Waiting", true);
    41      
    42      /** toString value of the item. */
    43      private final String value;
    44  
    45      /** Whether this state is terminal. */
    46      private final boolean terminal;
    47      
    48      /** 
    49       * Instantiates the enum. 
    50       *
    51       * @param value toString value
    52       * @param terminal Whether or not the state is terminal (i.e., whether there
    53       * are pending actions to be performed on the error)
    54       */
             /* 
    P/P       *  Method: void com.dmdirc.logger.ErrorReportStatus(String, int, String, bool)
              * 
              *  Postconditions:
              *    this.terminal == terminal
              *    init'ed(this.terminal)
              *    this.value == value
              *    init'ed(this.value)
              */
    55      ErrorReportStatus(final String value, final boolean terminal) {
    56          this.value = value;
    57          this.terminal = terminal;
    58      }
    59  
    60      /**
    61       * Determines whether or not this state is terminal. Terminal states are
    62       * defined as those on which no further actions will be performed without
    63       * user interaction. Non-terminal states may start or finish sending in
    64       * the future.
    65       * 
    66       * @return True if the state is terminal, false otherwise
    67       */
    68      public boolean isTerminal() {
                 /* 
    P/P           *  Method: bool isTerminal()
                  * 
                  *  Postconditions:
                  *    return_value == this.terminal
                  *    init'ed(return_value)
                  */
    69          return terminal;
    70      }
    71      
    72      /** {@inheritDoc} */
    73      @Override
    74      public String toString() {
                 /* 
    P/P           *  Method: String toString()
                  * 
                  *  Postconditions:
                  *    return_value == this.value
                  *    init'ed(return_value)
                  */
    75          return value;
    76      }
    77  }