01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.texteditor.spelling;
11:
12: /**
13: * A collector of {@link SpellingProblem}s. The {@link SpellingService} service
14: * will report its results to such a collector.
15: * <p>
16: * An implementer may specify if a collector is thread aware, i.e., if problems
17: * can be reported by any thread, potentially in parallel, and thus, multiple
18: * reporting sessions may be active at the same time. Clients of concrete
19: * collectors in turn must evaluate the usage of their collector and chose an
20: * appropriate implementation.
21: * </p>
22: * <p>
23: * This interface is intended to be implemented by clients.
24: * </p>
25: *
26: * @see SpellingService
27: * @since 3.1
28: */
29: public interface ISpellingProblemCollector {
30:
31: /**
32: * Notification of a spelling problem.
33: *
34: * @param problem the spelling problem
35: */
36: public void accept(SpellingProblem problem);
37:
38: /**
39: * Notification sent before starting to collect problems. This method
40: * will be called by the spelling infrastructure and is not intended
41: * to be called by clients.
42: */
43: public void beginCollecting();
44:
45: /**
46: * Notification sent after completing to collect problems. This method
47: * will be called by the spelling infrastructure and is not intended
48: * to be called by clients.
49: */
50: public void endCollecting();
51: }
|