tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/source/SourceDocumentMonitor.java
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
parent 41 tracefw/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/source/SourceDocumentMonitor.java@838cdffd57ce
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
41
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
* Monitor for source files
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
package com.nokia.tracecompiler.source;
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
/**
hgs
parents:
diff changeset
    22
 * Monitor for source files
hgs
parents:
diff changeset
    23
 * 
hgs
parents:
diff changeset
    24
 */
hgs
parents:
diff changeset
    25
public interface SourceDocumentMonitor extends
hgs
parents:
diff changeset
    26
		Iterable<SourceDocumentInterface> {
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
	/**
hgs
parents:
diff changeset
    29
	 * Gets a document factory, which is shared between all documents created
hgs
parents:
diff changeset
    30
	 * into this monitor
hgs
parents:
diff changeset
    31
	 * 
hgs
parents:
diff changeset
    32
	 * @return the factory
hgs
parents:
diff changeset
    33
	 */
hgs
parents:
diff changeset
    34
	public SourceDocumentFactory getFactory();
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
	/**
hgs
parents:
diff changeset
    37
	 * Starts the monitor
hgs
parents:
diff changeset
    38
	 * 
hgs
parents:
diff changeset
    39
	 * @param processor
hgs
parents:
diff changeset
    40
	 *            document processor callback
hgs
parents:
diff changeset
    41
	 * @throws Exception 
hgs
parents:
diff changeset
    42
	 */
hgs
parents:
diff changeset
    43
	public void startMonitor(SourceDocumentProcessor processor) throws Exception;
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
	/**
hgs
parents:
diff changeset
    46
	 * Stops the monitor
hgs
parents:
diff changeset
    47
	 */
hgs
parents:
diff changeset
    48
	public void stopMonitor();
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
}