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 ParameterFilter

    java.lang.Object
      com.sun.javatest.TestFilter
          com.sun.javatest.ObservableTestFilter
              com.sun.javatest.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`

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.javatest.ObservableTestFilter
`ObservableTestFilter.Observer`

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

Field Summary

Fields inherited from class com.sun.javatest.ObservableTestFilter
`observers`

Constructor Summary
`ParameterFilter()`

Method Summary
`boolean` | `accepts(TestDescription td)` Determines whether a TestDescription should be accepted or rejected by this filter.
`boolean` | `accepts(TestDescription td, TestFilter.Observer o)` Determines whether a TestDescription should be accepted or rejected by this filter; if rejected, it is reported to the provided observer.
`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()`.
`InitialUrlFilter` | `getIUrlFilter()`
`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.
`TestFilter[]` | `getTestFilters()` Gets the set of filters that the parameters have supplied.
`void` | `update(Parameters p)` Should be called whenever the parameters or filters inside may have changed.

Methods inherited from class com.sun.javatest.ObservableTestFilter
`addObserver, notifyUpdated, removeObserver`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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.

### getIUrlFilter

    public InitialUrlFilter getIUrlFilter()

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.