org.appdapter.api.registry.Finder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.appdapter.lib.registry Show documentation

Pluggable object registration + query service

There is a newer version: 1.2.4

Show newest version

/*
 *  Copyright 2012 by The Appdapter Project (www.appdapter.org).
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.appdapter.api.registry;


/**
 * Finder is a type-parametrized interface used to search for matches to a Pattern.
 * The finder can only locate Registry objects that match its own type parameter.
 * The finder delivers pattern matches to a Receiver.
 * 
 * @author Stu B. 
 */
public interface Finder {
	// TODO: Add bounds estimation 
	// public  MatchEstimateBounds	estimateMatchCount(Pattern p);
	
	// This thread will block, returning ResultSequence only after exhausting
	// finder's index, or after Receiver returns Status=DONE.
	public ResultSequence deliverMatchesUntilDone(Pattern p, Receiver r);
	
	public void killDeliverySequence(ResultSequence resultSeq);
}