IActivityPatternBinding


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