/* 
    P/P   *  Method: com.dmdirc.parser.irc.ProcessInvite__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.parser.irc;
    24  
    25  /**
    26   * Process an Invite Request.
    27   */
    28  public class ProcessInvite extends IRCProcessor {
    29  	/**
    30  	 * Process an Invite Request.
    31  	 *
    32  	 * @param sParam Type of line to process ("INVITE")
    33  	 * @param token IRCTokenised line to process
    34  	 */
    35  	@Override
    36  	public void process(final String sParam, final String[] token) {
    37  		// :Tobavaj!shane@Tobavaj.users.quakenet.org INVITE Dataforce #dataforceisgod 1188846462
        		 /* 
    P/P 		  *  Method: void process(String, String[])
        		  * 
        		  *  Preconditions:
        		  *    token != null
        		  *    token.length != 3
        		  *    (soft) this.myParser != null
        		  *    (soft) this.myParser.myCallbackManager != null
        		  *    (soft) this.myParser.myCallbackManager.callbackHash != null
        		  *    (soft) token[0] != null
        		  *    (soft) init'ed(token[3])
        		  * 
        		  *  Test Vectors:
        		  *    token.length: {0..2}, {4..+Inf}
        		  */
    38  		if (token.length > 2) {
    39  			callInvite(token[0].substring(1), token[3]);
    40  		}
    41  	}
    42  	
    43  	/**
    44  	 * Callback to all objects implementing the Invite Callback.
    45  	 *
    46  	 * @see IInvite
    47  	 * @param userHost The hostname of the person who invited us
    48  	 * @param channel The name of the channel we were invited to
    49  	 * @return true if a method was called, false otherwise
    50  	 */
    51  	protected boolean callInvite(final String userHost, final String channel) {
        		 /* 
    P/P 		  *  Method: bool callInvite(String, String)
        		  * 
        		  *  Preconditions:
        		  *    this.myParser != null
        		  *    this.myParser.myCallbackManager != null
        		  *    this.myParser.myCallbackManager.callbackHash != null
        		  * 
        		  *  Presumptions:
        		  *    getCallbackManager(...)@52 init'ed
        		  * 
        		  *  Postconditions:
        		  *    init'ed(return_value)
        		  */
    52  		return getCallbackManager().getCallbackType("OnInvite").call(userHost, channel);
    53  	}
    54  	
    55  	/**
    56  	 * What does this IRCProcessor handle.
    57  	 *
    58  	 * @return String[] with the names of the tokens we handle.
    59  	 */
    60  	@Override
    61  	public String[] handles() {
        		 /* 
    P/P 		  *  Method: String[] handles()
        		  * 
        		  *  Postconditions:
        		  *    return_value == &new String[](handles#1)
        		  *    new String[](handles#1) num objects == 1
        		  *    return_value.length == 1
        		  *    return_value[0] == &"INVITE"
        		  */
    62  		return new String[]{"INVITE"};
    63  	} 
    64  	
    65  	/**
    66  	 * Create a new instance of the IRCProcessor Object.
    67  	 *
    68  	 * @param parser IRCParser That owns this IRCProcessor
    69  	 * @param manager ProcessingManager that is in charge of this IRCProcessor
    70  	 */
        	 /* 
    P/P 	  *  Method: void com.dmdirc.parser.irc.ProcessInvite(IRCParser, ProcessingManager)
        	  * 
        	  *  Postconditions:
        	  *    this.myManager == manager
        	  *    init'ed(this.myManager)
        	  *    this.myParser == parser
        	  *    init'ed(this.myParser)
        	  */
    71  	protected ProcessInvite (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
    72  
    73  }