javax.tv.service.navigation.ServiceFilter 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.Service;
/**
* This class represents a set filtering criteria used to generate a
* ServiceList. ServiceFilter is extended
* to create concrete filters based on various criteria. Applications
* may also extend this class to define custom filters, although
* custom filters may not be supported on certain filtering
* operations.
*
* @see ServiceList
*/
public abstract class ServiceFilter
{
/**
* Constructs the filter.
*/
protected ServiceFilter() { }
/**
* Tests if a particular service passes this filter.
* Subtypes of ServiceFilter override this method to
* provide the logic for a filtering operation on individual
* Service objects.
*
* @param service A Service to be evaluated
* against the filtering algorithm.
*
* @return true if service satisfies the
* filtering algorithm; false otherwise.
*/
public abstract boolean accept(Service service);
}