/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.Notice__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.ServerState;
    27  import com.dmdirc.commandparser.CommandArguments;
    28  import com.dmdirc.commandparser.CommandManager;
    29  import com.dmdirc.commandparser.commands.CommandOptions;
    30  import com.dmdirc.commandparser.commands.IntelligentCommand;
    31  import com.dmdirc.commandparser.commands.ServerCommand;
    32  import com.dmdirc.ui.input.AdditionalTabTargets;
    33  import com.dmdirc.ui.input.TabCompletionType;
    34  import com.dmdirc.ui.interfaces.InputWindow;
    35  
    36  import java.util.List;
    37  
    38  /**
    39   * Allows the user to send notices.
    40   * @author chris
    41   */
    42  @CommandOptions(allowOffline=false)
    43  public final class Notice extends ServerCommand implements IntelligentCommand {
    44      
    45      /**
    46       * Creates a new instance of Notice.
    47       */
    48      public Notice() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.Notice()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    49          super();
    50          
    51          CommandManager.registerCommand(this);
    52      }
    53      
    54      /** {@inheritDoc} */
    55      @Override
    56      public void execute(final InputWindow origin, final Server server,
    57              final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    (soft) args.line != null
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  *    (soft) server != null
                  * 
                  *  Presumptions:
                  *    com.dmdirc.Server:getParser(...)@61 != null
                  *    getArguments(...).length@61 >= 1
                  *    getArguments(...).length@63 >= 1
                  *    java.util.Arrays:copyOfRange(...)@99 != 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:
                  *    getArguments(...).length@58: {2..+Inf}, {0,1}
                  */
    58          if (args.getArguments().length < 2) {
    59              showUsage(origin, isSilent, "notice", "<target> <message>");
    60          } else {
    61              server.getParser().sendLine("NOTICE " + args.getArguments()[0] + " :"
    62                      + args.getArgumentsAsString(1));
    63              sendLine(origin, isSilent, "selfNotice", args.getArguments()[0],
    64                      args.getArgumentsAsString(1));
    65          }
    66      }
    67      
    68      
    69      /** {@inheritDoc} */
    70      @Override
    71      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"notice"
                  */
    72          return "notice";
    73      }
    74      
    75      /** {@inheritDoc} */
    76      @Override
    77      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    78          return true;
    79      }
    80      
    81      /** {@inheritDoc} */
    82      @Override
    83      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"notice <target> <message> - sends a notice"
                  */
    84          return "notice <target> <message> - sends a notice";
    85      }
    86  
    87      /** {@inheritDoc} */
    88      @Override
    89      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Presumptions:
                  *    init'ed(com.dmdirc.ui.input.TabCompletionType.COMMAND)
                  * 
                  *  Postconditions:
                  *    return_value == &amp;new AdditionalTabTargets(getSuggestions#1)
                  *    new AdditionalTabTargets(getSuggestions#1) num objects == 1
                  * 
                  *  Test Vectors:
                  *    arg: {-231..-1, 1..232-1}, {0}
                  */
    90          final AdditionalTabTargets targets = new AdditionalTabTargets();
    91          
    92          if (arg == 0) {
    93              targets.exclude(TabCompletionType.COMMAND);
    94          }
    95          
    96          return targets;
    97      }
    98      
    99  }