org.ocap.application.AppFilterHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ocap Show documentation

There is a newer version: 1.3.1

package org.ocap.application;

import org.dvb.application.AppID;
import org.dvb.application.AppsDatabaseFilter;

/**
 * Application programs can provide an implementation of this
 * interface to an {@link AppFilter} to make part of decision
 * for AppFilter.accept.
 *
 * @see AppFilter#setAskHandler
 */
public interface AppFilterHandler {
    /**
     * This method is called by {@link AppFilter#accept} when it finds a
     * matching AppPattern whose action is
     * ASK.
     *
     * The return value of this method will be the return value of
     * AppFilter.accept.  The semantics of this method is
     * identical to {@link AppsDatabaseFilter#accept} except that the
     * additional parameter matchingItem could be used as a
     * hint.
     *
     * @param appID an AppID to test.
     *
     * @param matchingItem the AppPattern in
     * AppFilter that matched appID
     *
     * @return true if appID passes this
     * filter.
     */
    public boolean accept(AppID appID, AppPattern matchingItem);
}