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.ui.interfaces;
    24  
    25  import java.util.Locale;
    26  
    27  /**
    28   * Frame manager position enum.
    29   */
         /* 
    P/P   *  Method: void com.dmdirc.ui.interfaces.FramemanagerPosition(String, int)
          */
    30  public enum FramemanagerPosition {
    31      /** Top of the window. */
             /* 
    P/P       *  Method: com.dmdirc.ui.interfaces.FramemanagerPosition__static_init
              * 
              *  Postconditions:
              *    $VALUES == &new FramemanagerPosition[](FramemanagerPosition__static_init#6)
              *    BOTTOM == &new FramemanagerPosition(FramemanagerPosition__static_init#3)
              *    $VALUES[2] == &new FramemanagerPosition(FramemanagerPosition__static_init#3)
              *    LEFT == &new FramemanagerPosition(FramemanagerPosition__static_init#2)
              *    $VALUES[1] == &new FramemanagerPosition(FramemanagerPosition__static_init#2)
              *    RIGHT == &new FramemanagerPosition(FramemanagerPosition__static_init#4)
              *    $VALUES[3] == &new FramemanagerPosition(FramemanagerPosition__static_init#4)
              *    TOP == &new FramemanagerPosition(FramemanagerPosition__static_init#1)
              *    $VALUES[0] == &new FramemanagerPosition(FramemanagerPosition__static_init#1)
              *    UNKNOWN == &new FramemanagerPosition(FramemanagerPosition__static_init#5)
              *    ...
              */
    32      TOP,
    33      /** Left side of the window. */
    34      LEFT,
    35      /** Bottom of the window. */
    36      BOTTOM,
    37      /** Right side of the window. */
    38      RIGHT,
    39      /** Unknown position. */
    40      UNKNOWN;
    41      
    42      /**
    43       * Returns the frame position for s specified string.
    44       *
    45       * @param name Name of the string
    46       *
    47       * @return FramemanagerPosition for the string
    48       */
    49      public static FramemanagerPosition getPosition(final String name) {
                 /* 
    P/P           *  Method: FramemanagerPosition getPosition(String)
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  * 
                  *  Test Vectors:
                  *    name: Inverse{null}, Addr_Set{null}
                  */
    50          if (name == null) {
    51              return UNKNOWN;
    52          }
    53          try {
    54              return valueOf(name.toUpperCase(Locale.getDefault()));
    55          } catch (IllegalArgumentException ex) {
    56              return valueOf("UNKNOWN");
    57          }
    58      }
    59      
    60      /**
    61       * Determines if this position is one of the two horizontal positions.
    62       * 
    63       * @return True if this is a horizontal position, false otherwise
    64       */
    65      public boolean isHorizontal() {
                 /* 
    P/P           *  Method: bool isHorizontal()
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    66          return this == TOP || this == BOTTOM;
    67      }
    68  }