Class PreferenceFilterEntry


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

      • PreferenceFilterEntry

        public PreferenceFilterEntry​(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​(String key,
                                     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 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 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