Eclipse Plug-in Developer Guide (Galileo) - IActivityPatternBinding (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.activities
Interface IActivityPatternBinding

All Superinterfaces:: Comparable

public interface IActivityPatternBinding
extends Comparable
extends Comparable

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 IIdentifier.

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

String getActivityId ()
          Returns the identifier of the activity represented in this binding.

Pattern getPattern ()
          Returns the pattern represented in this binding.

String getString ()
          If isEqualityPattern() is true 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 the java.util.regex.Pattern class. If isEqualityPattern() is true a Pattern will be generated based on the escaped version of the String returned by getString().

Returns:: the pattern. Guaranteed not to be null.

getString


String getString()

If isEqualityPattern() is true 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. If true, 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