Package org.eclipse.ui.activities
Interface IActivityPatternBinding
-
- All Superinterfaces:
Comparable<IActivityPatternBinding>
public interface IActivityPatternBinding extends Comparable<IActivityPatternBinding>
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 ofIIdentifier
.This interface is not intended to be extended or implemented by clients.
- Since:
- 3.0
- See Also:
IActivity
,IIdentifier
,IActivityManager.getIdentifier(String)
- Restriction:
- This interface is not intended to be implemented by clients.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getActivityId()
Returns the identifier of the activity represented in this binding.Pattern
getPattern()
Returns the pattern represented in this binding.String
getString()
IfisEqualityPattern()
istrue
this will return the raw pattern string.boolean
isEqualityPattern()
Answers whether or not the pattern should be treated as a regular string or a regular expression.-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Method Detail
-
getActivityId
String getActivityId()
Returns the identifier of the activity represented in this binding.- Returns:
- the identifier of the activity represented in this binding.
Guaranteed not to be
null
.
-
getPattern
Pattern getPattern()
Returns the pattern represented in this binding. This pattern should conform to the regular expression syntax described by thejava.util.regex.Pattern
class. IfisEqualityPattern()
istrue
a Pattern will be generated based on the escaped version of the String returned bygetString()
.- Returns:
- the pattern. Guaranteed not to be
null
.
-
getString
String getString()
IfisEqualityPattern()
istrue
this will return the raw pattern string. Otherwise it will return the string version of the compiled pattern.- Returns:
- The raw pattern string, or the string version of the
compiled pattern, depending on
isEqualityPattern()
. - Since:
- 3.4
-
isEqualityPattern
boolean isEqualityPattern()
Answers whether or not the pattern should be treated as a regular string or a regular expression. Iftrue
, this pattern binding will represent an equality match between the pattern and a target ID rather than a regular expression match.- Returns:
- whether the pattern should be treated as regular string
- Since:
- 3.4
-
-