Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: c25e322a576f5a78c22264437ec78fbf7454fd0f (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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.core.expressions" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.core.expressions" id="commonExpression" name="Common Expressions"/>
      </appInfo>
      <documentation>
         
      </documentation>
   </annotation>

   <element name="enablement">
      <annotation>
         <documentation>
            A generic root element. The element can be used inside an extension point to define its enablement expression.
            The children of an enablement expression are combined using the &quot;and&quot; operator.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
      </complexType>
   </element>

   <element name="not">
      <annotation>
         <documentation>
            This element represents a NOT operation on the result of evaluating its sub-element expression.
         </documentation>
      </annotation>
      <complexType>
         <choice>
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </choice>
      </complexType>
   </element>

   <element name="and">
      <annotation>
         <documentation>
            This element represents an AND operation on the result of evaluating all its sub-elements expressions.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
      </complexType>
   </element>

   <element name="or">
      <annotation>
         <documentation>
            This element represent an  OR operation on the result of evaluating all its sub-element expressions.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
      </complexType>
   </element>

   <element name="instanceof">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="value"/>
         </appInfo>
         <documentation>
            This element is used to perform an instanceof check of the object in focus. The expression returns
            EvaluationResult.TRUE if the object&apos;s type is a sub type of the type specified by the attribute value.
            Otherwise EvaluationResult.FALSE is returned.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="value" type="string" use="required">
            <annotation>
               <documentation>
                  a fully qualified name of a class or interface.
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="java.lang.Object"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="test">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="property"/>
         </appInfo>
         <documentation>
            This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the &lt;b&gt;org.eclipse.core.expressions.propertyTesters&lt;/b&gt; extension point. The test expression returns EvaluationResult.NOT_LOADED if the property tester doing the actual testing isn&apos;t loaded yet and the attribute forcePluginActivation is set to false.  If forcePluginActivation is set to true and the evaluation context used to evaluate this expression support plug-in activation then evaluating the property will result in activating the plug-in defining the tester.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="property" type="string" use="required">
            <annotation>
               <documentation>
                  the name of an object&apos;s property to test.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="args" type="string">
            <annotation>
               <documentation>
                  additional arguments passed to the property tester. Multiple arguments are separated
                  by commas. Each individual argument is converted into a Java base type using the same
                  rules as defined for the value attribute of the test expression.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="value" type="string">
            <annotation>
               <documentation>
                  the expected value of the property. Can be omitted if the property 
                  is a boolean property (value will be Boolean.TRUE). The test expression is supposed to return
EvaluationResult.TRUE if the property matches the value and EvaluationResult.FALSE
otherwise. The value attribute is converted into a Java base type using the following
rules:
&lt;ul&gt;
 &lt;li&gt;the string &amp;quot;true&amp;quot; is converted into Boolean.TRUE&lt;/li&gt;
 &lt;li&gt;the string &amp;quot;false&amp;quot; is converted into Boolean.FALSE&lt;/li&gt;
 &lt;li&gt;if the string contains a dot then the interpreter tries to convert
 the value into a Float object. If this fails the string is treated as a
 java.lang.String&lt;/li&gt;
 &lt;li&gt;if the string only consists of numbers then the interpreter
 converts the value into an Integer object.&lt;/li&gt;
 &lt;li&gt;in all other cases the string is treated as a java.lang.String&lt;/li&gt;
 &lt;li&gt;the conversion of the string into a Boolean, Float, or Integer can
 be suppressed by surrounding the string with single quotes. For
 example, the attribute value=&amp;quot;&apos;true&apos;&amp;quot; is converted into the
 string &amp;quot;true&amp;quot;&lt;/li&gt;
&lt;/ul&gt;
               </documentation>
            </annotation>
         </attribute>
         <attribute name="forcePluginActivation" type="boolean">
            <annotation>
               <documentation>
                  a flag indicating whether the plug-in contributing the property tester
                  should be loaded if necessary. As such, this flag should be used judiciously, 
                  in order to avoid unnecessary plug-in activations. Most clients should avoid
                  setting this flag to true. This flag is only honored if the evaluation context
                  used to evaluate this expression allows plug-in activation. Otherwise the flag
                  is ignored and no plug-in loading takes place.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="systemTest">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="value"/>
         </appInfo>
         <documentation>
            Tests a system property by calling the System.getProperty method and compares the result
            with the value specified through the value attribute.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="property" type="string" use="required">
            <annotation>
               <documentation>
                  the name of an system property to test.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="value" type="string" use="required">
            <annotation>
               <documentation>
                  the expected value of the property. The value is interpreted as a string value.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="equals">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="value"/>
         </appInfo>
         <documentation>
            This element is used to perform an equals check of the object in focus. The expression returns
            EvaluationResult.TRUE if the object is equal to the value provided by the attribute value. Otherwise
            EvaluationResult.FALSE is returned.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="value" type="string" use="required">
            <annotation>
               <documentation>
                  the expected value. The value provided as a string is converted into
                  a Java base type using the same rules as for the value attribute of the test expression.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="count">
      <annotation>
         <documentation>
            This element is used to test the number of elements in a collection.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="value" type="string" use="required">
            <annotation>
               <documentation>
                  an expression to specify the number of elements in a list. Following wildcard
                  characters can be used:
                  &lt;dl&gt;
                    &lt;dt&gt;*&lt;/dt&gt; &lt;dd&gt;any number of elements&lt;/dd&gt;
                    &lt;dt&gt;?&lt;/dt&gt; &lt;dd&gt;no elements or one element&lt;/dd&gt;
                    &lt;dt&gt;+&lt;/dt&gt; &lt;dd&gt;one or more elements&lt;/dd&gt;
                    &lt;dt&gt;!&lt;/dt&gt; &lt;dd&gt;no elements&lt;/dd&gt;
                    &lt;dt&gt;-&lt;i&gt;N&lt;/i&gt;)&lt;/dt&gt;
                    &lt;dd&gt;less than &lt;i&gt;N&lt;/i&gt; elements&lt;/dd&gt;
                    &lt;dt&gt;(&lt;i&gt;N&lt;/i&gt;-&lt;/dt&gt;
                    &lt;dd&gt;greater than &lt;i&gt;N&lt;/i&gt; elements&lt;/dd&gt;
                    &lt;dt&gt;integer value&lt;/dt&gt; &lt;dd&gt;the list must contain the exact number of elements&lt;/dd&gt;
                  &lt;/dl&gt;
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="with">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="variable"/>
         </appInfo>
         <documentation>
            This element changes the object to be inspected for all its child element to the object
            referenced by the given variable. If the variable can not be resolved then the expression
            will throw an ExpressionException when evaluating it. The children of a with expression 
            are combined using the &quot;and&quot; operator.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
         <attribute name="variable" type="string" use="required">
            <annotation>
               <documentation>
                  the name of the variable to be used for further inspection. It is up to the evaluator
                  of an extension point to provide the variable in the variable pool.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="resolve">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="variable"/>
         </appInfo>
         <documentation>
            This element changes the object to be inspected for all its child element to the object
            referenced by the given variable. If the variable can not be resolved then the expression
            will throw an ExpressionException when evaluating it. The children of a resolve expression 
            are combined using the &quot;and&quot; operator.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
         <attribute name="variable" type="string" use="required">
            <annotation>
               <documentation>
                  the name of the variable to be resolved. This variable is then used as the object in focus
                  for child element evaluation. It is up to the evaluator of an extension point to provide a 
                  corresponding variable resolver (see IVariableResolver) through the evaluation context passed
                  to the root expression element when evaluating the expression.
               </documentation>
            </annotation>
         </attribute>
         <attribute name="args" type="string">
            <annotation>
               <documentation>
                  additional arguments passed to the variable resolver. Multiple arguments are separated
                  by commas. Each individual argument is converted into a Java base type using the same
                  rules as defined for the value attribute of the test expression.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="adapt">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="type"/>
         </appInfo>
         <documentation>
            This element is used to adapt the object in focus to the type specified by the attribute
            type. The expression returns EvaluationResult.NOT_LOADED if either the adapter or the type referenced isn&apos;t
            loaded yet. It throws an ExpressionException during evaluation if the type name doesn&apos;t exist 
            at all. The children of an adapt expression are combined using the &quot;and&quot; operator.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
         <attribute name="type" type="string" use="required">
            <annotation>
               <documentation>
                  the type to which the object in focus is to be adapted.
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="java.lang.Object"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="iterate">
      <annotation>
         <documentation>
            This element is used to iterate over a variable that is of type java.util.Collection, or a variable that
            adapts to org.eclipse.core.expressions.IIterable. If the object in focus is not one of the above then a
            CoreException with an ExpressionStatus will be thrown while evaluating the expression.
            The child expressions of an iterate expression are combined using the &quot;and&quot; operator.
         </documentation>
      </annotation>
      <complexType>
         <sequence minOccurs="0" maxOccurs="unbounded">
            <element ref="not"/>
            <element ref="and"/>
            <element ref="or"/>
            <element ref="instanceof"/>
            <element ref="test"/>
            <element ref="systemTest"/>
            <element ref="equals"/>
            <element ref="count"/>
            <element ref="with"/>
            <element ref="resolve"/>
            <element ref="adapt"/>
            <element ref="iterate"/>
            <element ref="reference"/>
         </sequence>
         <attribute name="operator">
            <annotation>
               <documentation>
                  either &quot;and&quot; or &quot;or&quot;. The operator defines how the results of all the child expressions
                  applied to each child of the Collection or IIterable will be combined and what (if any) short circuit
                  evaluation will be used. If not specified, &quot;and&quot; will be used.
               </documentation>
            </annotation>
            <simpleType>
               <restriction base="string">
                  <enumeration value="or">
                  </enumeration>
                  <enumeration value="and">
                  </enumeration>
               </restriction>
            </simpleType>
         </attribute>
         <attribute name="ifEmpty" type="boolean">
            <annotation>
               <documentation>
                  the value returned from the &quot;iterate&quot; expression if the collection is empty. If
                 not specified then EvaluationResult.TRUE is returned when the operator equals &quot;and&quot; 
                 and EvaluationResult.FALSE is returned if the operator equals &quot;or&quot;.
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="reference">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="definitionId"/>
         </appInfo>
         <documentation>
            This element is used to reference an expression from the &lt;b&gt;org.eclipse.core.expressions.definitions&lt;/b&gt; extension point.  The expression definition will be evaluated within the current expression element using the current evaluation context.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="definitionId" type="string" use="required">
            <annotation>
               <documentation>
                  The unique id of an expression from &lt;b&gt;org.eclipse.core.expressions.definitions&lt;/b&gt;.
               </documentation>
               <appInfo>
                  <meta.attribute kind="identifier" basedOn="org.eclipse.core.expressions.definitions/definition/@id"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         Release 3.0
      </documentation>
   </annotation>




   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         Copyright (c) 2001, 2013 IBM Corporation and others.&lt;br&gt;

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 &lt;a href=&quot;https://www.eclipse.org/legal/epl-2.0&quot;&gt;https://www.eclipse.org/legal/epl-v20.html&lt;/a&gt;/

SPDX-License-Identifier: EPL-2.0
      </documentation>
   </annotation>

</schema>

Back to the top