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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.search.ui.text;
import org.eclipse.core.runtime.Assert;
/**
* A textual match in a given object. This class may be instantiated and also subclassed (to add
* additional match state like accuracy, etc). The element a match is reported
* against is assumed to contain the match, and the UI will group matches
* against the same element together. A match has an offset and a length which
* may be specified in characters or in lines.
*
* @since 3.0
*/
public class Match {
/**
* A constant expressing that offset and length of this match are specified
* in lines
*/
public static final int UNIT_LINE= 1;
/**
* A constant expressing that offset and length of this match are specified
* in characters
*/
public static final int UNIT_CHARACTER= 2;
private static final int IS_FILTERED= 1 << 2;
private Object fElement;
private int fOffset;
private int fLength;
private int fFlags;
/**
* Constructs a new Match object.
*
* @param element
* the element that contains the match
* @param unit
* the unit offset and length are based on
* @param offset
* the offset the match starts at
* @param length
* the length of the match
*/
public Match(Object element, int unit, int offset, int length) {
Assert.isTrue(unit == UNIT_CHARACTER || unit == UNIT_LINE);
fElement= element;
fOffset= offset;
fLength= length;
fFlags= unit;
}
/**
* Constructs a new Match object. The offset and length will be based on
* characters.
*
* @param element
* the element that contains the match
* @param offset
* the offset the match starts at
* @param length
* the length of the match
*/
public Match(Object element, int offset, int length) {
this(element, UNIT_CHARACTER, offset, length);
}
/**
* Returns the offset of this match.
*
* @return the offset
*/
public int getOffset() {
return fOffset;
}
/**
* Sets the offset of this match.
*
* @param offset
* the offset to set
*/
public void setOffset(int offset) {
fOffset= offset;
}
/**
* Returns the length of this match.
*
* @return the length
*/
public int getLength() {
return fLength;
}
/**
* Sets the length.
*
* @param length
* the length to set
*/
public void setLength(int length) {
fLength= length;
}
/**
* Returns the element that contains this match. The element is used to group the match.
*
* @return the element that contains this match
*/
public Object getElement() {
return fElement;
}
/**
* Returns whether match length and offset are expressed in lines or
* characters.
*
* @return either UNIT_LINE or UNIT_CHARACTER;
*/
public int getBaseUnit() {
if ((fFlags & UNIT_LINE) != 0)
return UNIT_LINE;
return UNIT_CHARACTER;
}
/**
* Marks this match as filtered or not.
*
* @param value <code>true</code> if the match is filtered;
* otherwise <code>false</code>
*
* @since 3.1
*/
public void setFiltered(boolean value) {
if (value) {
fFlags |= IS_FILTERED;
} else {
fFlags &= (~IS_FILTERED);
}
}
/**
* Returns whether this match is filtered or not.
*
* @return <code>true</code> if the match is filtered; otherwise
* <code>false</code>
*
* @since 3.1
*/
public boolean isFiltered() {
return (fFlags & IS_FILTERED) != 0;
}
}
|
