/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.Back__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.server;
    24  
    25  import com.dmdirc.Server;
    26  import com.dmdirc.commandparser.CommandArguments;
    27  import com.dmdirc.commandparser.CommandManager;
    28  import com.dmdirc.commandparser.commands.CommandOptions;
    29  import com.dmdirc.commandparser.commands.IntelligentCommand;
    30  import com.dmdirc.commandparser.commands.ServerCommand;
    31  import com.dmdirc.ui.input.AdditionalTabTargets;
    32  import com.dmdirc.ui.interfaces.InputWindow;
    33  
    34  import java.util.List;
    35  
    36  /**
    37   * The back command allows the user to unset their away status.
    38   * @author chris
    39   */
    40  @CommandOptions(allowOffline=false)
    41  public final class Back extends ServerCommand implements IntelligentCommand {
    42      
    43      /**
    44       * Creates a new instance of Back.
    45       */
    46      public Back() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.Back()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    47          super();
    48          
    49          CommandManager.registerCommand(this);
    50      }
    51      
    52      /**
    53       * Executes this command.
    54       * @param origin The frame in which this command was issued
    55       * @param server The server object that this command is associated with
    56       * @param isSilent Whether this command is silenced or not
    57       * @param args The user supplied arguments
    58       */
    59      @Override
    60      public void execute(final InputWindow origin, final Server server,
    61              final boolean isSilent, final CommandArguments args) {        
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    server != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Server:getParser(...)@62 != null
                  */
    62          server.getParser().sendLine("AWAY");
    63      }
    64      
    65      
    66      /** {@inheritDoc}. */
    67      @Override
    68      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"back"
                  */
    69          return "back";
    70      }
    71      
    72      /** {@inheritDoc}. */
    73      @Override
    74      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    75          return true;
    76      }
    77      
    78      /** {@inheritDoc}. */
    79      @Override
    80      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &"back - unsets your away status"
                  */
    81          return "back - unsets your away status";
    82      }
    83  
    84      /** {@inheritDoc} */
    85      @Override
    86      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    87          return new AdditionalTabTargets().excludeAll();
    88      }
    89      
    90  }