/* 
    P/P   *  Method: com.dmdirc.addons.dcop.DcopCommand__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.addons.dcop;
    24  
    25  import com.dmdirc.Server;
    26  import com.dmdirc.commandparser.CommandArguments;
    27  import com.dmdirc.commandparser.CommandManager;
    28  import com.dmdirc.commandparser.commands.ServerCommand;
    29  import com.dmdirc.ui.interfaces.InputWindow;
    30  
    31  import java.util.List;
    32  
    33  /**
    34   * The dcop command retrieves information from a dcop application.
    35   * @author chris
    36   */
    37  public final class DcopCommand extends ServerCommand {
    38      
    39      /**
    40       * Creates a new instance of DcopCommand.
    41       */
    42      public DcopCommand() {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.dcop.DcopCommand()
                  */
    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
                  * 
                  *  Presumptions:
                  *    com.dmdirc.commandparser.CommandArguments:getArguments(...)@52 != null
                  * 
                  *  Test Vectors:
                  *    com.dmdirc.commandparser.CommandArguments:getArguments(...).length@52: {3}, {0..2, 4..+Inf}
                  *    java.util.Iterator:hasNext(...)@58: {0}, {1}
                  */
    52          if (args.getArguments().length != 3) {
    53              showUsage(origin, isSilent, "dcop", "<app> <object> <function>");
    54              return;
    55          }
    56          
    57          final List<String> res = DcopPlugin.getDcopResult("dcop " + args.getArgumentsAsString());
    58          for (String line : res) {
    59              sendLine(origin, isSilent, FORMAT_OUTPUT, line);
    60          }
    61      }
    62      
    63      
    64      /** {@inheritDoc} */
    65      @Override
    66      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"dcop"
                  */
    67          return "dcop";
    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;"dcop <app> <object> <function> - retrieves information from a DCOP aplication"
                  */
    79          return "dcop <app> <object> <function> - retrieves information from a DCOP aplication";
    80      }
    81      
    82  }