org.eclipse.equinox.p2.query.IQueryable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.equinox.p2.metadata Show documentation

The newest version!

/*******************************************************************************
 * Copyright (c) 2007, 2010 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.equinox.p2.query;

import org.eclipse.core.runtime.IProgressMonitor;

/**
 * An IQueryable contains objects, and is able to perform queries on those objects.
 * 
 * This interface may be implemented by clients.
 * @since 2.0
 */
public interface IQueryable {
	/**
	 * Performs a query, passing any objects that satisfy the
	 * query to the provided collector.
	 * 

	 * This method is long-running; progress and cancellation are provided
	 * by the given progress monitor. 
	 * 
	 * 
	 * @param query The query to perform
	 * @param monitor a progress monitor, or null if progress
	 *    reporting is not desired
	 * @return The collector argument
	 */
	public IQueryResult query(IQuery query, IProgressMonitor monitor);
}