Class ParameterFilter


  • public class ParameterFilter
    extends ObservableTestFilter
    This filter knows how to deal with the the Parameters interface to get the necessary filtering effect.
    See Also:
    Parameters
    • Constructor Detail

      • ParameterFilter

        public ParameterFilter()
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: TestFilter
        Get the name of this filter, as might be used to choose of of a set of filters. This string should be localized.
        Specified by:
        getName in class TestFilter
        Returns:
        the name of this filter
      • getDescription

        public java.lang.String getDescription()
        Description copied from class: TestFilter
        Get a description of this filter, as might be used to give more details about this filter than provided by TestFilter.getName(). This string should be localized.
        Specified by:
        getDescription in class TestFilter
        Returns:
        a description of this filter
      • getReason

        public java.lang.String getReason()
        Description copied from class: TestFilter
        Get the reason why this filter would reject a test, as might be used in reports. This string should be localized.
        Specified by:
        getReason in class TestFilter
        Returns:
        a rejection reason for this filter
      • accepts

        public boolean accepts​(TestDescription td)
                        throws TestFilter.Fault
        Description copied from class: TestFilter
        Determines whether a TestDescription should be accepted or rejected by this filter.
        Specified by:
        accepts in class TestFilter
        Parameters:
        td - the TestDescription to check
        Returns:
        true if td should be included in collection; false otherwise.
        Throws:
        TestFilter.Fault - if an error occurs while trying to determine if this test should be accepted or not.
      • accepts

        public boolean accepts​(TestDescription td,
                               TestFilter.Observer o)
                        throws TestFilter.Fault
        Description copied from class: TestFilter
        Determines whether a TestDescription should be accepted or rejected by this filter; if rejected, it is reported to the provided observer.
        Overrides:
        accepts in class TestFilter
        Parameters:
        td - The TestDescription to check.
        o - An observer, which will be notified if the test is rejected by this filter.
        Returns:
        true if td should be included in collection; false otherwise.
        Throws:
        TestFilter.Fault - if an error occurs while trying to determine if this test should be accepted or not.
      • getTestFilters

        public TestFilter[] getTestFilters()
        Gets the set of filters that the parameters have supplied. Depending on the initial url setting, an InitialUrlFilter may or may not be included in this set. The returned array has already be shallow copied.
        Returns:
        The filters in use. This is affected by the isFilterTests() state.
        See Also:
        InitialUrlFilter
      • update

        public void update​(Parameters p)
        Should be called whenever the parameters or filters inside may have changed.