com.sun.dtv.filtering
Class FilteringStoppedEvent

java.lang.Object
  java.util.EventObject
      com.sun.dtv.filtering.DataSectionFilterEvent
          com.sun.dtv.filtering.FilteringStoppedEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FilterTimedOutEvent

public class FilteringStoppedEvent
extends DataSectionFilterEvent

This class is used to report the end of a filtering operation with one exception: It is not generated when filtering stops for a SimpleSectionFilter under normal circumstances (i.e. after one section has successfully been filtered).

See Also:

DataSectionFilterEvent, Serialized Form

Field Summary

static int	CAUSE_FILTER_INCOMPLETE Incomplete filter cause
static int	CAUSE_FILTER_RESOURCE_LOST Section filter resources are removed from a connected DataSectionFilterCollection.
static int	CAUSE_FILTER_TIMEOUT This cause is generated if section filter operations time out within the period specified by the setTimeOut() method.
static int	CAUSE_TRANSPORT_STREAM_DISCONNECTED A TransportStream which was attached to a DataSectionFilterCollection gets disconnected or becomes unavailable, causing filtering to stop.
static int	CAUSE_UNKNOWN Unknown cause
static int	CAUSE_VERSION_CHANGE_DETECTED This cause is used by ListFilter to report that a section has been encountered which has a different version_number from earlier sections.

Fields inherited from class java.util.EventObject

source

Constructor Summary

FilteringStoppedEvent(DataSectionFilter f, Object refObj)
This constructs an FilteringStoppedEvent for the specified DataSectionFilter object.

FilteringStoppedEvent(DataSectionFilter f, Object refObj, int cause)
This constructs an FilteringStoppedEvent for the specified DataSectionFilter object.

Method Summary

int	getCause() Set the cause for the filtering operation being stopped.

Methods inherited from class com.sun.dtv.filtering.DataSectionFilterEvent

getrefObj, getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CAUSE_UNKNOWN

public static final int CAUSE_UNKNOWN

Unknown cause

See Also:

Constant Field Values

CAUSE_FILTER_INCOMPLETE

public static final int CAUSE_FILTER_INCOMPLETE

Incomplete filter cause

See Also:

Constant Field Values

CAUSE_FILTER_TIMEOUT

public static final int CAUSE_FILTER_TIMEOUT

This cause is generated if section filter operations time out within the period specified by the setTimeOut() method.

For a SimpleSectionFilter it will be generated if no sections arrive within the specified period.

For a TableSectionFilter, it will be generated if the complete table does not arrive within the specified time.

For a RingSectionFilter, it will be generated if the specified time has elapsed since the arrival of the last section being successfully filtered.

See Also:

Constant Field Values

CAUSE_VERSION_CHANGE_DETECTED

public static final int CAUSE_VERSION_CHANGE_DETECTED

This cause is used by ListFilter to report that a section has been encountered which has a different version_number from earlier sections. It is generated only once per filtering action. The section with a different version_number is ignored.

See Also:

Constant Field Values

CAUSE_FILTER_RESOURCE_LOST

public static final int CAUSE_FILTER_RESOURCE_LOST

Section filter resources are removed from a connected DataSectionFilterCollection.

See Also:

Constant Field Values

CAUSE_TRANSPORT_STREAM_DISCONNECTED

public static final int CAUSE_TRANSPORT_STREAM_DISCONNECTED

A TransportStream which was attached to a DataSectionFilterCollection gets disconnected or becomes unavailable, causing filtering to stop.

See Also:

Constant Field Values

Constructor Detail

FilteringStoppedEvent

public FilteringStoppedEvent(DataSectionFilter f,
                             Object refObj)

This constructs an FilteringStoppedEvent for the specified DataSectionFilter object.

Parameters:

f - the DataSectionFilter object where the event originated

refObj - application data that was passed to the startFiltering method

FilteringStoppedEvent

public FilteringStoppedEvent(DataSectionFilter f,
                             Object refObj,
                             int cause)

This constructs an FilteringStoppedEvent for the specified DataSectionFilter object.

This constructor permits the cause of the filter stopping to be specified

Parameters:

f - the DataSectionFilter object where the event originated

refObj - application data that was passed to the startFiltering method

cause - the cause of the filter stopping

Method Detail

getCause

public int getCause()

Set the cause for the filtering operation being stopped.

Returns:

the cause enumeration