/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.global.Exit__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.Main;
    26  import com.dmdirc.commandparser.CommandArguments;
    27  import com.dmdirc.commandparser.CommandManager;
    28  import com.dmdirc.commandparser.commands.GlobalCommand;
    29  import com.dmdirc.ui.interfaces.InputWindow;
    30  
    31  /**
    32   * The exit command allows the user to quit DMDirc with a custom quit message.
    33   * When the client quits, it disconnects all servers (with the quit message
    34   * supplied) and saves the config file.
    35   * @author chris
    36   */
    37  public final class Exit extends GlobalCommand {
    38      
    39      /**
    40       * Creates a new instance of Exit.
    41       */
    42      public Exit() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.global.Exit()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    43          super();
    44          
    45          CommandManager.registerCommand(this);
    46      }
    47      
    48      /** {@inheritDoc} */
    49      @Override
    50      public void execute(final InputWindow origin, final boolean isSilent,
    51              final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    (soft) args.line != null
                  *    (soft) origin != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.ui.interfaces.InputWindow:getConfigManager(...).sources@52 != null
                  *    com.dmdirc.ui.interfaces.InputWindow:getConfigManager(...)@52 != null
                  *    java.util.Arrays:copyOfRange(...)@99 != null
                  * 
                  *  Postconditions:
                  *    args.words != null
                  *    init'ed(java.lang.String:split(...)._tainted)
                  *    java.lang.String:split(...)._tainted == 0
                  *    init'ed(java.lang.String:split(...).length)
                  * 
                  *  Test Vectors:
                  *    getArguments(...).length@52: {0}, {1..+Inf}
                  */
    52          Main.quit(args.getArguments().length > 0 ? args.getArgumentsAsString()
    53                  : origin.getConfigManager().getOption("general", "closemessage"));
    54      }
    55      
    56      
    57      /** {@inheritDoc}. */
    58      @Override
    59      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"exit"
                  */
    60          return "exit";
    61      }
    62      
    63      /** {@inheritDoc}. */
    64      @Override
    65      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    66          return true;
    67      }
    68          
    69      /** {@inheritDoc}. */
    70      @Override
    71      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &"exit [reason] - exits the client"
                  */
    72          return "exit [reason] - exits the client";
    73      }
    74      
    75  }