Java DTV API 1.3
18-Nov-2009

com.sun.dtv.filtering
Class SingleFilter

java.lang.Object
  extended by com.sun.dtv.filtering.DataSectionFilter
      extended by com.sun.dtv.filtering.SingleFilter
All Implemented Interfaces:
Cloneable

public class SingleFilter
extends DataSectionFilter

This class defines a section filter intended to be used to capture a single data section. When a section matching the specified filter pattern is found, SingleFilter objects will stop. An DataSectionAvailableEvent will be generated when a DataSection is captured. Filtering will then stop.

See Also:
DataSection, DataSectionFilter

Method Summary
 DataSection getSection()
          This method retrieves a single DataSection object describing a section which matched the active filter definition.
 
Methods inherited from class com.sun.dtv.filtering.DataSectionFilter
addSectionFilterListener, clearGreaterThanFilter, clearLessThanFilter, clearPositiveFilter, clearTableId, clearXorFilter, removeSectionFilterListener, setGreaterThanFilter, setLessThanFilter, setPid, setPositiveFilter, setTableId, setTimeOut, setXorFilter, startFiltering, stopFiltering
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSection

public DataSection getSection()
                       throws FilterInterruptException
This method retrieves a single DataSection object describing a section which matched the active filter definition. This method will never block and will return null if no section has yet matched.

Each time a new filtering operation is started, a new DataSection object will be created. All references except any in the application to the previous DataSection object will be removed. All data accessing methods on the previous DataSection object will throw a NoDataAvailableException.

Returns:
the single matched DataSection object or null.
Throws:
FilterInterruptException - if the filter was interrupted before the required amount of data was filtered.

Java DTV API 1.3
18-Nov-2009

Copyright © 2008-2009 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved.

U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Sun, Sun Microsystems, the Sun logo and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.Products covered by and information contained in this service manual are controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

Use of this document is subject to license terms.