javax.tv.service.navigation.SIElementFilter Maven / Gradle / Ivy
/**
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2008 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative use only. For example,
this file and any files generated from it may be used to generate other documentation,
such as a unified set of documents of API signatures for a platform
that includes technologies expressed as Java APIs.
This file may also be used to produce "compilation stubs,"
which allow applications to be compiled and validated for such platforms.
By contrast, no permission is given for you to incorporate this file,
in whole or in part, in an implementation of a Java specification.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 927: Java TV API 1.1.1.
In the event of a discrepency between this work and the JSR 927 specification,
which is available at http://www.jcp.org/en/jsr/detail?id=927, the latter takes precedence.
*/
package javax.tv.service.navigation;
import javax.tv.service.*;
/**
* SIElementFilter represents a
* ServiceFilter based on a particular
* SIElement (such as a TransportStream or
* ProgramEvent). A ServiceList resulting
* from this filter will include only Service objects
* with one or more corresponding ServiceDetails,
* sd, such that:
*
* -
sd is contained by
* the specified SIElement, or
* sd
* contains the specified SIElement
*
* -- according to the
* type of SIElement provided. Note that no guarantee
* is made that every SIElement type is supported for
* filtering.
*
* @see SIElement
* @see ServiceList
*/
public final class SIElementFilter extends ServiceFilter
{
/**
* Constructs the filter based on a particular SIElement.
*
* @param element An SIElement indicating the services
* to be included in a resulting service list.
*
* @throws FilterNotSupportedException If element is
* not supported for filtering.
*/
public SIElementFilter(SIElement element) throws FilterNotSupportedException
{ }
/**
* Reports the SIElement used to create this filter.
*
* @return The SIElement used to create this filter.
*/
public SIElement getFilterValue() {
return null;
}
/**
* Tests if the given service passes the filter.
*
* @param service An individual Service to be evaluated
* against the filtering algorithm.
*
* @return true if service has a
* corresponding ServiceDetails which contains or
* is contained by the SIElement indicated
* by the filter value; false otherwise.
*/
public boolean accept(Service service) {
return false;
}
}