KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > search > internal > core > ISearchScope


1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.search.internal.core;
12
13 import org.eclipse.core.resources.IResourceProxy;
14
15 /**
16  * Defines a scope to which search results are limited.
17  */
18 public interface ISearchScope {
19
20     /**
21      * Checks whether the given element is enclosed by
22      * this scope or not.
23      *
24      * @param element the resource proxy to be checked
25      * @return <code>true</code> if the resource is inside the search scope
26      *
27      */
28     public boolean encloses(IResourceProxy element);
29
30     /**
31      * Returns a human readable description of this scope
32      *
33      * @return the description of this scope as <code>String</code>
34      *
35      */
36     public String JavaDoc getDescription();
37 }
38
Popular Tags