Package org.eclipse.core.runtime.preferences

Class PreferenceFilterEntry

  • public final class PreferenceFilterEntry
extends java.lang.Object
    Class which represents and preference filter entry to be used during preference import/export (for example).
    Since:
    3.1
    See Also:
    IPreferenceFilter

    • Constructor Summary

      Constructors 
      Constructor Description
      PreferenceFilterEntry​(java.lang.String key)
      Constructor for the class.
      PreferenceFilterEntry​(java.lang.String key, java.lang.String matchType)
      Constructor for the class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getKey()
      Return the name of the preference key for this filter entry.
      java.lang.String getMatchType()
      Return the match type specified for this filter.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PreferenceFilterEntry

        public PreferenceFilterEntry​(java.lang.String key)
        Constructor for the class. Create a new preference filter entry with the given key. The key must not be null or empty.
        Parameters:
        key - the name of the preference key

      • PreferenceFilterEntry

        public PreferenceFilterEntry​(java.lang.String key,
                             java.lang.String matchType)
        Constructor for the class. Create a new preference filter entry with the given key and match type. The key must not be null or empty.

        Setting matchType to "prefix" treats the key as if it were a regular expression with an asterisk at the end. If matchType is null, the key must be an exact match.

        Parameters:
        key - the name of the preference key
        matchType - specifies key match type, may be null to indicate that exact match is required
        Since:
        3.3

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Return the name of the preference key for this filter entry. It will not return null or the empty string.
        Returns:
        the name of the preference key

      • getMatchType

        public java.lang.String getMatchType()
        Return the match type specified for this filter. May return null to indicate that exact match is used.
        Returns:
        matchType the match type, might be null indicating that exact match is used
        Since:
        3.3