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.addons.time;
    24  
    25  import com.dmdirc.actions.interfaces.ActionMetaType;
    26  import com.dmdirc.actions.interfaces.ActionType;
    27  
    28  /**
    29   * Lists the actions that the time plugin will raise.
    30   * @author chris
    31   */
         /* 
    P/P   *  Method: TimeActionType valueOf(String)
          * 
          *  Postconditions:
          *    init'ed(return_value)
          */
    32  public enum TimeActionType implements ActionType {
    33      
    34      /** Minute type. */
             /* 
    P/P       *  Method: com.dmdirc.addons.time.TimeActionType__static_init
              * 
              *  Postconditions:
              *    $VALUES == &new TimeActionType[](TimeActionType__static_init#4)
              *    TIME_DAY == &new TimeActionType(TimeActionType__static_init#3)
              *    $VALUES[2] == &new TimeActionType(TimeActionType__static_init#3)
              *    TIME_HOUR == &new TimeActionType(TimeActionType__static_init#2)
              *    $VALUES[1] == &new TimeActionType(TimeActionType__static_init#2)
              *    TIME_MINUTE == &new TimeActionType(TimeActionType__static_init#1)
              *    $VALUES[0] == &new TimeActionType(TimeActionType__static_init#1)
              *    new TimeActionType(TimeActionType__static_init#1) num objects == 1
              *    new TimeActionType(TimeActionType__static_init#2) num objects == 1
              *    new TimeActionType(TimeActionType__static_init#3) num objects == 1
              *    ...
              */
    35      TIME_MINUTE("Every minute"),
    36      /** Hour type. */
    37      TIME_HOUR("Every hour"),
    38      /** Day type. */
    39      TIME_DAY("Every day");
    40      
    41      /** Action type name. */
    42      private final String name;
    43      
    44      /**
    45       * Creates a new instance of a TimeActionType.
    46       * @param name The name of the action type
    47       */
             /* 
    P/P       *  Method: void com.dmdirc.addons.time.TimeActionType(String, int, String)
              * 
              *  Postconditions:
              *    this.name == name
              *    init'ed(this.name)
              */
    48      TimeActionType(final String name) {
    49          this.name = name;
    50      }
    51      
    52      /** {@inheritDoc} */
    53      @Override
    54      public ActionMetaType getType() {
                 /* 
    P/P           *  Method: ActionMetaType getType()
                  * 
                  *  Postconditions:
                  *    return_value == &com.dmdirc.addons.time.TimeActionMetaType__static_init.new TimeActionMetaType$1(TimeActionMetaType__static_init#1)
                  */
    55          return TimeActionMetaType.TIME_TIME;
    56      }
    57      
    58      /** {@inheritDoc} */
    59      @Override
    60      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == this.name
                  *    init'ed(return_value)
                  */
    61          return name;
    62      }
    63      
    64  }