org.symbian.tools.wrttools/src/org/symbian/tools/wrttools/sdt/utils/IMessageListener.java
changeset 50 0560e98b9bf6
equal deleted inserted replaced
43:464130c45935 50:0560e98b9bf6
       
     1 /**
       
     2  * Copyright (c) 2009 Symbian Foundation and/or its subsidiary(-ies).
       
     3  * All rights reserved.
       
     4  * This component and the accompanying materials are made available
       
     5  * under the terms of the License "Eclipse Public License v1.0"
       
     6  * which accompanies this distribution, and is available
       
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8  *
       
     9  * Initial Contributors:
       
    10  * Symbian Foundation - initial contribution.
       
    11  * Contributors:
       
    12  * Description:
       
    13  * Overview:
       
    14  * Details:
       
    15  * Platforms/Drives/Compatibility:
       
    16  * Assumptions/Requirement/Pre-requisites:
       
    17  * Failures and causes:
       
    18  */
       
    19 package org.symbian.tools.wrttools.sdt.utils;
       
    20 
       
    21 /**
       
    22  * This interface listens to messages reported from various
       
    23  * parts of Sedona (sourcegen, scripting, ...) which should
       
    24  * be shown to the user.
       
    25  * 
       
    26  * @author eswartz
       
    27  *
       
    28  */
       
    29 public interface IMessageListener {
       
    30 	/**
       
    31 	 * Tell if the message should be emitted by this listener,
       
    32 	 * usually true for a solitary listener.  It would return false,
       
    33 	 * e.g., if several listeners are attached and each has a particular 
       
    34 	 * resource scope for messages, and the given message doesn't match
       
    35 	 * this listener's scope. 
       
    36 	 */
       
    37 	public boolean isHandlingMessage(IMessage msg);
       
    38 	
       
    39     /**
       
    40      * Emit a message if #isHandlingMessage() returned true.
       
    41      * @param msg
       
    42      */
       
    43     public void emitMessage(IMessage msg);
       
    44 }