/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.RawServerCommand__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   * Implements a raw server command (i.e., a command that is sent to the server
    34   * as-is.
    35   * 
    36   * @author chris
    37   */
    38  @CommandOptions(allowOffline=false)
    39  public final class RawServerCommand extends ServerCommand {
    40      
    41      /** The name of this raw command. */
    42      private final String myName;
    43      
    44      /**
    45       * Creates a new instance of RawServerCommand.
    46       * 
    47       * @param command The command name for this raw command
    48       */
    49      public RawServerCommand(final String command) {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.RawServerCommand(String)
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  * 
                  *  Postconditions:
                  *    this.myName == command
                  *    init'ed(this.myName)
                  */
    50          super();
    51          
    52          myName = command;
    53          
    54          CommandManager.registerCommand(this);
    55      }
    56      
    57      /** {@inheritDoc} */
    58      @Override
    59      public void execute(final InputWindow origin, final Server server,
    60              final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    server != null
                  *    this.myName != null
                  *    (soft) args.line != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Server:getParser(...)@61 != 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)
                  */
    61          server.getParser().sendLine(myName.toUpperCase() + " " + args.getArgumentsAsString());
    62      }
    63      
    64      
    65      /** {@inheritDoc} */
    66      @Override
    67      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == this.myName
                  *    init'ed(return_value)
                  */
    68          return myName;
    69      }
    70      
    71      /** {@inheritDoc} */
    72      @Override
    73      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    74          return true;
    75      }
    76      
    77      /** {@inheritDoc} */
    78      @Override
    79      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    java.lang.StringBuilder:toString(...)._tainted == this.myName._tainted
                  *    init'ed(java.lang.StringBuilder:toString(...)._tainted)
                  *    return_value == &java.lang.StringBuilder:toString(...)
                  */
    80          return myName + " [arguments] - sends a " + myName + " command to the server";
    81      }
    82      
    83  }