Class KeywordsFilter


  • public class KeywordsFilter
    extends TestFilter
    A test filter that filters tests according to the keywords on a test description.
    • Constructor Summary

      Constructors 
      Constructor Description
      KeywordsFilter​(Keywords keywords)
      Create a filter that filters tests according to a Keywords object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accepts​(TestDescription td)
      Determines whether a TestDescription should be accepted or rejected by this filter.
      boolean equals​(java.lang.Object o)  
      java.lang.String getDescription()
      Get a description of this filter, as might be used to give more details about this filter than provided by TestFilter.getName().
      Keywords getKeywords()
      Get the underlying keywords object.
      java.lang.String getName()
      Get the name of this filter, as might be used to choose of of a set of filters.
      java.lang.String getReason()
      Get the reason why this filter would reject a test, as might be used in reports.
      int hashCode()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • KeywordsFilter

        public KeywordsFilter​(Keywords keywords)
        Create a filter that filters tests according to a Keywords object.
        Parameters:
        keywords - an object that provides the basic filter
    • Method Detail

      • getKeywords

        public Keywords getKeywords()
        Get the underlying keywords object.
        Returns:
        the keywords object that provides the basic filter
      • 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)
        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.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object