blob: 974e2cc414b399058f40d44cfdf81f93ada78fd3 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2018 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.ui.activities;
import java.util.regex.Pattern;
/**
* An instance of this interface represents a binding between an activity and a
* regular expression pattern. It's typically unnecessary to use this interface
* directly. Rather, clients wishing to test strings against activity patterns
* should use instances of <code>IIdentifier</code>.
* <p>
* This interface is not intended to be extended or implemented by clients.
* </p>
*
* @since 3.0
* @see IActivity
* @see IIdentifier
* @see IActivityManager#getIdentifier(String)
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IActivityPatternBinding extends Comparable<IActivityPatternBinding> {
/**
* Returns the identifier of the activity represented in this binding.
*
* @return the identifier of the activity represented in this binding.
* Guaranteed not to be <code>null</code>.
*/
String getActivityId();
/**
* Returns the pattern represented in this binding. This pattern should conform
* to the regular expression syntax described by the
* <code>java.util.regex.Pattern</code> class. If {@link #isEqualityPattern()}
* is <code>true</code> a Pattern will be generated based on the escaped version
* of the String returned by {@link #getString()}.
*
* @return the pattern. Guaranteed not to be <code>null</code>.
*/
Pattern getPattern();
/**
* If {@link #isEqualityPattern()} is <code>true</code> this will return the raw
* <em>pattern</em> string. Otherwise it will return the string version of the
* compiled pattern.
*
* @return The raw <em>pattern</em> string, or the string version of the
* compiled pattern, depending on {@link #isEqualityPattern()}.
* @since 3.4
*/
String getString();
/**
* Answers whether or not the pattern should be treated as a regular string or a
* regular expression. If <code>true</code>, this pattern binding will represent
* an equality match between the pattern and a target ID rather than a regular
* expression match.
*
* @return whether the pattern should be treated as regular string
* @since 3.4
*/
boolean isEqualityPattern();
}
|
