01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.activities;
11:
12: import java.util.regex.Pattern;
13:
14: /**
15: * An instance of this interface represents a binding between an activity and a
16: * regular expression pattern. It's typically unnecessary to use this interface
17: * directly. Rather, clients wishing to test strings against activity patterns
18: * should use instances of <code>IIdentifier</code>.
19: * <p>
20: * This interface is not intended to be extended or implemented by clients.
21: * </p>
22: *
23: * @since 3.0
24: * @see IActivity
25: * @see IIdentifier
26: * @see IActivityManager#getIdentifier(String)
27: */
28: public interface IActivityPatternBinding extends Comparable {
29:
30: /**
31: * Returns the identifier of the activity represented in this binding.
32: *
33: * @return the identifier of the activity represented in this binding.
34: * Guaranteed not to be <code>null</code>.
35: */
36: String getActivityId();
37:
38: /**
39: * Returns the pattern represented in this binding. This pattern should
40: * conform to the regular expression syntax described by the
41: * <code>java.util.regex.Pattern</code> class.
42: *
43: * @return the pattern. Guaranteed not to be <code>null</code>.
44: */
45: Pattern getPattern();
46: }
|