/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.Away__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.ServerCommand;
    30  import com.dmdirc.ui.interfaces.InputWindow;
    31  
    32  /**
    33   * The away command allows the user to set their away message.
    34   * @author chris
    35   */
    36  @CommandOptions(allowOffline=false)
    37  public final class Away extends ServerCommand {
    38      
    39      /**
    40       * Creates a new instance of Away.
    41       */
    42      public Away() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.Away()
                  * 
                  *  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 Server server,
    51              final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    server != null
                  *    (soft) args.line != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Server:getParser(...)@54 != 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)
                  */
    52          final String line = args.getArgumentsAsString();
    53  
    54          server.getParser().sendLine("AWAY :" + line);
    55      }
    56      
    57      
    58      /** {@inheritDoc} */
    59      @Override
    60      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"away"
                  */
    61          return "away";
    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 == &amp;"away <reason> - marks you as away"
                  */
    73          return "away <reason> - marks you as away";
    74      }
    75      
    76  }