/* 
    P/P   *  Method: com.dmdirc.commandparser.commands.global.Notify__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.global;
    24  
    25  import com.dmdirc.commandparser.CommandArguments;
    26  import com.dmdirc.commandparser.CommandManager;
    27  import com.dmdirc.commandparser.commands.GlobalCommand;
    28  import com.dmdirc.commandparser.commands.IntelligentCommand;
    29  import com.dmdirc.ui.input.AdditionalTabTargets;
    30  import com.dmdirc.ui.interfaces.InputWindow;
    31  import com.dmdirc.ui.messages.ColourManager;
    32  
    33  import java.awt.Color;
    34  import java.util.List;
    35  
    36  /**
    37   * The notify command allows the user to set the notification colour for a
    38   * window.
    39   * 
    40   * @author chris
    41   */
    42  public final class Notify extends GlobalCommand implements IntelligentCommand {
    43      
    44      /**
    45       * Creates a new instance of Notify.
    46       */
    47      public Notify() {
                 /* 
    P/P           *  Method: void com.dmdirc.commandparser.commands.global.Notify()
                  * 
                  *  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 boolean isSilent,
    56              final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    init'ed(args.words)
                  *    (soft) args.line != null
                  *    (soft) init'ed(com/dmdirc/commandparser/CommandManager.commandChar)
                  * 
                  *  Presumptions:
                  *    com.dmdirc.ui.interfaces.InputWindow:getContainer(...)@71 != 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:
                  *    origin: Addr_Set{null}, Inverse{null}
                  *    com.dmdirc.ui.messages.ColourManager:parseColour(...)@62: Inverse{null}, Addr_Set{null}
                  *    getArguments(...).length@57: {1..+Inf}, {0}
                  */
    57          if (args.getArguments().length == 0) {
    58              showUsage(origin, isSilent, "notify", "<colour>");
    59              return;
    60          }
    61          
    62          final Color colour = ColourManager.parseColour(args.getArguments()[0], null);
    63          
    64          if (colour == null) {
    65              showUsage(origin, isSilent, "notify",
    66                      "<colour> - colour must be an IRC colour code (0-15) or a " +
    67                      "hex string (e.g. FFFF00).");
    68          } else if (origin != null) {            
    69              // There's not much point echoing an error if the origin isn't
    70              // valid, as errors go to the origin!
    71              origin.getContainer().sendNotification(colour);
    72          }
    73      }
    74      
    75      /** {@inheritDoc} */
    76      @Override
    77      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"notify"
                  */
    78          return "notify";
    79      }
    80      
    81      /** {@inheritDoc} */
    82      @Override
    83      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 0
                  */
    84          return false;
    85      }
    86      
    87      /** {@inheritDoc} */
    88      @Override
    89      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"notify <colour> - sets the notification colour for this window"
                  */
    90          return "notify <colour> - sets the notification colour for this window";
    91      }
    92  
    93      /** {@inheritDoc} */
    94      @Override
    95      public AdditionalTabTargets getSuggestions(final int arg, final List<String> previousArgs) {
                 /* 
    P/P           *  Method: AdditionalTabTargets getSuggestions(int, List)
                  * 
                  *  Postconditions:
                  *    init'ed(return_value)
                  */
    96          return new AdditionalTabTargets().excludeAll();
    97      } 
    98      
    99  }