org.eclipse.ltk.core.refactoring.participants

Interface IParticipantDescriptorFilter

public interface IParticipantDescriptorFilter

A participant descriptor filter allows clients to provide additional filters on participant selection.

Since:

3.2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME A constant indicating a name attribute (value: name)
static java.lang.String	PARAM A constant indicating a param element (value: param)
static java.lang.String	VALUE A constant indicating a value attribute (value: value)

Method Summary

Modifier and Type	Method and Description
boolean	select(IConfigurationElement element, RefactoringStatus status) Returns whether the given element makes it through this filter.

Field Detail

PARAM

static final java.lang.String PARAM

A constant indicating a param element (value: param)

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

A constant indicating a name attribute (value: name)

See Also:

Constant Field Values

VALUE

static final java.lang.String VALUE

A constant indicating a value attribute (value: value)

See Also:

Constant Field Values

Method Detail

select

boolean select(IConfigurationElement element,
               RefactoringStatus status)

Returns whether the given element makes it through this filter.

Parameters:

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