Copyright (c) 2000, 2008 IBM Corporation and others. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ SPDX-License-Identifier: EPL-2.0 Contributors: IBM Corporation - initial API and implementation
/******************************************************************************* * Copyright (c) 2000, 2008 IBM Corporation and others. * * This program and the accompanying materials * are made available under the terms of the Eclipse Public License 2.0 * which accompanies this distribution, and is available at * https://www.eclipse.org/legal/epl-2.0/ * * SPDX-License-Identifier: EPL-2.0 * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/
package org.eclipse.ltk.core.refactoring.participants; import org.eclipse.core.runtime.IConfigurationElement; import org.eclipse.ltk.core.refactoring.RefactoringStatus;
A participant descriptor filter allows clients to provide additional filters on participant selection.
Since:3.2
/** * A participant descriptor filter allows clients to provide * additional filters on participant selection. * * @since 3.2 */
public interface IParticipantDescriptorFilter {
A constant indicating a param element (value: param)
/** A constant indicating a param element (value: <code>param</code>) */
public static final String PARAM= "param"; //$NON-NLS-1$
A constant indicating a name attribute (value: name)
/** A constant indicating a name attribute (value: <code>name</code>) */
public static final String NAME= "name"; //$NON-NLS-1$
A constant indicating a value attribute (value: value)
/** A constant indicating a value attribute (value: <code>value</code>) */
public static final String VALUE= "value"; //$NON-NLS-1$
Returns whether the given element makes it through this filter.
Params:
  • element – the configuration element describing the refactoring participant
  • status – a RefactoringStatus to optionally add warning messages if the participant was not selected
Returns:true if element is included, and false if excluded
/** * Returns whether the given element makes it through this filter. * * @param element the configuration element describing the refactoring * participant * @param status a RefactoringStatus to optionally add warning messages if the participant * was not selected * * @return <code>true</code> if element is included, and * <code>false</code> if excluded */
public boolean select(IConfigurationElement element, RefactoringStatus status); }