blob: 0bd6ecfdf52a85a423db248ddc5568f6cab6cede (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.externaltools.internal.ant.editor.text;
import java.util.Iterator;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Display;
/**
* Interface of annotations representing markers
* and problems.
*
* @see org.eclipse.core.resources.IMarker
* @see org.eclipse.jdt.core.compiler.IProblem
*/
public interface IXMLAnnotation {
AnnotationType getAnnotationType();
boolean isTemporary();
String getMessage();
Image getImage(Display display);
/**
* Returns whether this annotation is relavant.
* <p>
* If the annotation is overlaid then it is not
* relevant. After all overlays have been removed
* the annotation might either become relevant again
* or stay irrelevant.
* </p>
*
* @return <code>true</code> if relevant
* @see #hasOverlay()
*/
boolean isRelevant();
/**
* Returns whether this annotation is overlaid.
*
* @return <code>true</code> if overlaid
*/
boolean hasOverlay();
/**
* Returns an iterator for iterating over the
* annotation which are overlaid by this annotation.
*
* @return an iterator over the overlaid annotaions
*/
Iterator getOverlaidIterator();
/**
* Adds the given annotation to the list of
* annotations which overlaid by this annotations.
*
* @param annotation the problem annoation
*/
void addOverlaid(IXMLAnnotation annotation);
/**
* Removes the given annotation from the list of
* annotations which are overlaid by this annotation.
*
* @param annotation the problem annoation
*/
void removeOverlaid(IXMLAnnotation annotation);
/**
* Tells whether this annotation is a problem
* annotation.
*
* @return <code>true</code> if it is a problem annotation
*/
boolean isProblem();
}
|
