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;
11:
12: import org.eclipse.jface.text.IDocument;
13: import org.eclipse.jface.text.Position;
14:
15: import org.eclipse.core.resources.IMarker;
16:
17: /**
18: * A marker updater is responsible for saving changes to markers.
19: * Marker updaters either update markers of a specific types or
20: * any type. Also they either assume update responsibility for a
21: * specific set of marker attributes or any marker attribute.
22: * Marker updater must be registered with an
23: * {@link org.eclipse.ui.texteditor.AbstractMarkerAnnotationModel}.
24: */
25: public interface IMarkerUpdater {
26:
27: /**
28: * Returns the marker type for which this updater is responsible. If
29: * the result is <code>null</code>, the updater assumes responsibility
30: * for any marker type.
31: *
32: * @return the marker type or <code>null</code> for any marker type
33: */
34: String getMarkerType();
35:
36: /**
37: * Returns the attributes for which this updater is responsible. If the
38: * result is <code>null</code>, the updater assumes responsibility for
39: * any attributes.
40: *
41: * @return the attributes or <code>null</code> for any attribute
42: */
43: String[] getAttribute();
44:
45: /**
46: * Updates the given marker according to the position of the given document.
47: * If the given position is <code>null</code>, the marker is assumed to
48: * carry the correct positional information.
49: *
50: * @param marker the marker to be updated
51: * @param document the document into which the given position points
52: * @param position the current position of the marker inside the given document
53: * @return <code>false</code> if the updater recognizes that the marker should be deleted
54: */
55: boolean updateMarker(IMarker marker, IDocument document,
56: Position position);
57: }
|