Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.sun.javatest
Class KeywordsFilter

    java.lang.Object
      com.sun.javatest.TestFilter
          com.sun.javatest.KeywordsFilter

    public class KeywordsFilter

extends TestFilter

A test filter that filters tests according to the keywords on a test description.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.javatest.TestFilter
`TestFilter.Fault, TestFilter.Observer`

Constructor Summary
`KeywordsFilter(Keywords keywords)` Create a filter that filters tests according to a Keywords object.

Method Summary
`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.

Methods inherited from class com.sun.javatest.TestFilter
`accepts`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, 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.

### equals

    public boolean equals(java.lang.Object o)

  Overrides:
    `equals` in class `java.lang.Object`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved.