/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.server.Nick__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.IntelligentCommand;
    30  import com.dmdirc.commandparser.commands.ServerCommand;
    31  import com.dmdirc.ui.input.AdditionalTabTargets;
    32  import com.dmdirc.ui.input.TabCompletionType;
    33  import com.dmdirc.ui.interfaces.InputWindow;
    34  
    35  import java.util.List;
    36  
    37  /**
    38   * Allows the user to change nickname.
    39   * @author chris
    40   */
    41  @CommandOptions(allowOffline=false)
    42  public final class Nick extends ServerCommand implements IntelligentCommand {
    43      
    44      /**
    45       * Creates a new instance of Nick.
    46       */
    47      public Nick() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.server.Nick()
                  * 
                  *  Preconditions:
                  *    init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  */
    48          super();
    49          
    50          CommandManager.registerCommand(this);
    51      }
    52      
    53      /** {@inheritDoc} */
    54      @Override
    55      public void execute(final InputWindow origin, final Server server,
    56              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(...)@62 != null
                  *    getArguments(...).length@62 >= 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@57: {1..+Inf}, {0}
                  */
    57          if (args.getArguments().length == 0) {
    58              showUsage(origin, isSilent, "nick", "<new nickname>");
    59              return;
    60          }
    61          
    62          server.getParser().setNickname(args.getArguments()[0]);
    63      }
    64      
    65      
    66      /** {@inheritDoc} */
    67      @Override
    68      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"nick"
                  */
    69          return "nick";
    70      }
    71      
    72      /** {@inheritDoc} */
    73      @Override
    74      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    75          return true;
    76      }
    77      
    78      /** {@inheritDoc} */
    79      @Override
    80      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"nick <new nickname> - attempts to change your nickname to the one specified"
                  */
    81          return "nick <new nickname> - attempts to change your nickname to the one specified";
    82      }
    83  
    84      /** {@inheritDoc} */
    85      @Override
    86      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..0}, {1..232-1}
                  */
    87          final AdditionalTabTargets res = new AdditionalTabTargets();
    88          
    89          res.exclude(TabCompletionType.COMMAND);
    90          
    91          if (arg > 0) {
    92              res.excludeAll();
    93          }
    94          
    95          return res;
    96      }
    97      
    98  }