/* 
    P/P   *  Method: com.dmdirc.commandparser.PopupMenu__static_init
          */
     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.commandparser;
    24  
    25  import java.util.ArrayList;
    26  import java.util.Collection;
    27  import java.util.List;
    28  
    29  /**
    30   * Represents an abstract, UI-independent popup menu.
    31   * 
    32   * @author chris
    33   */
         /* 
    P/P   *  Method: void com.dmdirc.commandparser.PopupMenu()
          * 
          *  Postconditions:
          *    this.items == &new ArrayList(PopupMenu#1)
          *    new ArrayList(PopupMenu#1) num objects == 1
          */
    34  public class PopupMenu {
    35      
    36      /** The items contained within this popup menu. */
    37      private final List<PopupMenuItem> items = new ArrayList<PopupMenuItem>();
    38      
    39      /**
    40       * Retrieves a list of items contained within this popup menu.
    41       * 
    42       * @return A list of this popup menu's items.
    43       */
    44      public List<PopupMenuItem> getItems() {
                 /* 
    P/P           *  Method: List getItems()
                  * 
                  *  Postconditions:
                  *    return_value == this.items
                  *    init'ed(return_value)
                  */
    45          return items;
    46      }
    47  
    48      /**
    49       * Adds the specified item to this popup menu.
    50       * 
    51       * @param e The item to be added to the popup menu.
    52       */
    53      public void add(final PopupMenuItem e) {
                 /* 
    P/P           *  Method: void add(PopupMenuItem)
                  * 
                  *  Preconditions:
                  *    this.items != null
                  */
    54          items.add(e);
    55      }
    56  
    57      /**
    58       * Adds all of the items in the specified collection to this popup menu.
    59       * 
    60       * @param c The collection whose items should be added.
    61       */
    62      public void addAll(final Collection<? extends PopupMenuItem> c) {
                 /* 
    P/P           *  Method: void addAll(Collection)
                  * 
                  *  Preconditions:
                  *    this.items != null
                  */
    63          items.addAll(c);
    64      }    
    65  
    66  }