IParticipantDescriptorFilter


1   /*******************************************************************************
2    * Copyright (c) 2000, 2005 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  package org.eclipse.ltk.core.refactoring.participants;
12  
13  import org.eclipse.core.runtime.IConfigurationElement;
14  
15  import org.eclipse.ltk.core.refactoring.RefactoringStatus;
16  
17  /**
18   * A participant descriptor filter allows clients to provide
19   * additional filters on participant selection.
20   * 
21   * @since 3.2
22   */
23  public interface IParticipantDescriptorFilter {
24      
25      /** A constant indicating a param element (value: <code>param</code>) */
26      public static final String   PARAM= "param"; //$NON-NLS-1$
27      
28      /** A constant indicating a name attribute (value: <code>name</code>) */
29      public static final String   NAME= "name"; //$NON-NLS-1$
30      
31      /** A constant indicating a value attribute (value: <code>value</code>) */
32      public static final String   VALUE= "value";  //$NON-NLS-1$
33      
34      /**
35       * Returns whether the given element makes it through this filter.
36       * 
37       * @param element the configuration element describing the refactoring
38       *  participant
39       * @param status a RefactoringStatus to optionally add warning messages if the participant
40       *  was not selected 
41       *  
42       * @return <code>true</code> if element is included, and 
43       *  <code>false</code> if excluded
44       */
45      public boolean select(IConfigurationElement element, RefactoringStatus status);
46  }
47

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags