Package org.eclipse.core.resources

Interface IFilterMatcherDescriptor

public interface IFilterMatcherDescriptor
A filter descriptor contains information about a filter type obtained from the plug-in manifest (plugin.xml) files.

Filter descriptors are platform-defined objects that exist independent of whether that filter's bundle has been started.

Since:
3.6
See Also:
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ARGUMENT_TYPE_FILTER_MATCHER
    An argument filter type constant (value "filter"), denoting that this filter takes another filter as argument.
    static final String
    ARGUMENT_TYPE_FILTER_MATCHERS
    An argument filter type constant (value "filters"), denoting that this filter takes an array of other filters as argument.
    static final String
    ARGUMENT_TYPE_NONE
    An argument filter type constant (value "none"), denoting that this filter does not take any arguments.
    static final String
    ARGUMENT_TYPE_STRING
    An argument filter type constant (value "string"), denoting that this filter takes a string argument

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArgumentType()
    Returns the argument type expected by this filter.
    String
    getDescription()
    Returns a translated, human-readable description for this filter extension.
    String
    getId()
    Returns the fully qualified id of the filter extension.
    String
    getName()
    Returns a translated, human-readable name for this filter extension.
    boolean
    isFirstOrdering()
    TODO What is this?

  • Field Details

    • ARGUMENT_TYPE_FILTER_MATCHER

      static final String ARGUMENT_TYPE_FILTER_MATCHER
      An argument filter type constant (value "filter"), denoting that this filter takes another filter as argument.
      See Also:

    • ARGUMENT_TYPE_FILTER_MATCHERS

      static final String ARGUMENT_TYPE_FILTER_MATCHERS
      An argument filter type constant (value "filters"), denoting that this filter takes an array of other filters as argument.
      See Also:

    • ARGUMENT_TYPE_NONE

      static final String ARGUMENT_TYPE_NONE
      An argument filter type constant (value "none"), denoting that this filter does not take any arguments.
      See Also:

    • ARGUMENT_TYPE_STRING

      static final String ARGUMENT_TYPE_STRING
      An argument filter type constant (value "string"), denoting that this filter takes a string argument
      See Also:

  • Method Details

    • getArgumentType

      String getArgumentType()
      Returns the argument type expected by this filter. The result will be one of the ARGUMENT_TYPE_* constants declared on this class.
      Returns:
      The argument type of this filter extension

    • getDescription

      String getDescription()
      Returns a translated, human-readable description for this filter extension.
      Returns:
      The human-readable filter description

    • getId

      String getId()
      Returns the fully qualified id of the filter extension.
      Returns:
      The fully qualified id of the filter extension.

    • getName

      String getName()
      Returns a translated, human-readable name for this filter extension.
      Returns:
      The human-readable filter name

    • isFirstOrdering

      boolean isFirstOrdering()
      TODO What is this?