/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.global.Clear__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.commands.global;
    24  
    25  import com.dmdirc.commandparser.CommandArguments;
    26  import com.dmdirc.commandparser.CommandManager;
    27  import com.dmdirc.commandparser.commands.GlobalCommand;
    28  import com.dmdirc.commandparser.commands.IntelligentCommand;
    29  import com.dmdirc.ui.input.AdditionalTabTargets;
    30  import com.dmdirc.ui.interfaces.InputWindow;
    31  
    32  import java.util.List;
    33  
    34  /**
    35   * The clear command clears the main text area of the current window.
    36   * 
    37   * @author chris
    38   */
    39  public final class Clear extends GlobalCommand implements IntelligentCommand {
    40      
    41      /**
    42       * Creates a new instance of Clear.
    43       */
    44      public Clear() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.global.Clear()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    45          super();
    46          
    47          CommandManager.registerCommand(this);
    48      }
    49      
    50      /** {@inheritDoc} */
    51      @Override
    52      public void execute(final InputWindow origin, final boolean isSilent, 
    53              final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    origin != null
                  */
    54          origin.clear();
    55      }
    56      
    57      
    58      /** {@inheritDoc} */
    59      @Override
    60      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"clear"
                  */
    61          return "clear";
    62      }
    63      
    64      /** {@inheritDoc} */
    65      @Override
    66      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    67          return true;
    68      }
    69      
    70      /** {@inheritDoc} */
    71      @Override
    72      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &"clear - clears the current window's text area"
                  */
    73          return "clear - clears the current window's text area";
    74      }
    75  
    76      /** {@inheritDoc} */
    77      @Override
    78      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    79          return new AdditionalTabTargets().excludeAll();
    80      } 
    81      
    82  }