DMDirc-Parser/src/com/dmdirc/parser/irc/ProcessMOTD.java

/*
 * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.parser.irc;

import com.dmdirc.parser.interfaces.callbacks.MotdEndListener;
import com.dmdirc.parser.interfaces.callbacks.MotdLineListener;
import com.dmdirc.parser.interfaces.callbacks.MotdStartListener;

/**
 * Process a MOTD Related Line.
 */
public class ProcessMOTD extends IRCProcessor {

    /**
     * Process a MOTD Related Line.
     *
     * @param sParam Type of line to process ("375", "372", "376", "422")
     * @param token IRCTokenised line to process
     */
    @Override
    public void process(String sParam, String[] token) {
        if (sParam.equals("375")) {
            callMOTDStart(token[token.length-1]);
        } else if (sParam.equals("372")) {
            callMOTDLine(token[token.length-1]);
        } else {
            callMOTDEnd(sParam.equals("422"), token[token.length-1]);
        }
    }
    
    /**
     * Callback to all objects implementing the MOTDEnd Callback.
     *
     * @param noMOTD Was this an MOTDEnd or NoMOTD
     * @param data The contents of the line (incase of language changes or so)
     * @see IMOTDEnd
     * @return true if a method was called, false otherwise
     */
    protected boolean callMOTDEnd(final boolean noMOTD, final String data) {
        return getCallbackManager().getCallbackType(MotdEndListener.class).call(noMOTD, data);
    }
    
    /**
     * Callback to all objects implementing the MOTDLine Callback.
     *
     * @see IMOTDLine
     * @param data Incomming Line.
     * @return true if a method was called, false otherwise
     */
    protected boolean callMOTDLine(final String data) {
        return getCallbackManager().getCallbackType(MotdLineListener.class).call(data);
    }
    
    /**
     * Callback to all objects implementing the MOTDStart Callback.
     *
     * @see IMOTDStart
     * @param data Incomming Line.
     * @return true if a method was called, false otherwise
     */
    protected boolean callMOTDStart(String data) {
        return getCallbackManager().getCallbackType(MotdStartListener.class).call(data);
    }
    
    /**
     * What does this IRCProcessor handle.
     *
     * @return String[] with the names of the tokens we handle.
     */
    @Override
    public String[] handles() {
        return new String[]{"372", "375", "376", "422"};
    } 
    
    /**
     * Create a new instance of the IRCProcessor Object.
     *
     * @param parser IRCParser That owns this IRCProcessor
     * @param manager ProcessingManager that is in charge of this IRCProcessor
     */
    protected ProcessMOTD (IRCParser parser, ProcessingManager manager) { super(parser, manager); }

}