/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.AllChannels__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.IntelligentCommand;
    29  import com.dmdirc.commandparser.commands.ServerCommand;
    30  import com.dmdirc.ui.input.AdditionalTabTargets;
    31  import com.dmdirc.ui.input.TabCompleter;
    32  import com.dmdirc.ui.interfaces.InputWindow;
    33  
    34  import java.util.List;
    35  
    36  /**
    37   * The AllChannels command allows the user to issue a command to all channels
    38   * on a server.
    39   * @author chris
    40   */
    41  public final class AllChannels extends ServerCommand implements IntelligentCommand {
    42      
    43      /** Creates a new instance of AllChannels. */
    44      public AllChannels() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.AllChannels()
                  * 
                  *  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 Server server,
    53              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
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.silenceChar)
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Channel:getFrame(...)@58 != null
                  *    com.dmdirc.Server:getChannel(...)@58 != null
                  *    com.dmdirc.Server:getChannels(...)@57 != null
                  *    com.dmdirc.ui.interfaces.InputWindow:getCommandParser(...).commands@59 != null
                  *    com.dmdirc.ui.interfaces.InputWindow:getCommandParser(...).history@59 != 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:
                  *    java.util.Iterator:hasNext(...)@57: {0}, {1}
                  */
    54          final String command = args.getArgumentsAsString();
    55          InputWindow window;
    56          
    57          for (String channel : server.getChannels()) {
    58              window = server.getChannel(channel).getFrame();
    59              window.getCommandParser().parseCommand(window, command);
    60          }
    61      }
    62      
    63      
    64      /** {@inheritDoc} */
    65      @Override
    66      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"allchannels"
                  */
    67          return "allchannels";
    68      }
    69      
    70      /** {@inheritDoc} */
    71      @Override
    72      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    73          return true;
    74      }
    75      
    76      /** {@inheritDoc} */
    77      @Override
    78      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"allchannels <command> - executes the command as though it hadbeen entered on all channels"
                  */
    79          return "allchannels <command> - executes the command as though it had" +
    80                  "been entered on all channels";
    81      }
    82  
    83      /** {@inheritDoc} */
    84      @Override
    85      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    86          return TabCompleter.getIntelligentResults(arg, previousArgs, 0);
    87      }
    88      
    89  }