org.eclipse.wst.jsdt.ui.search
Class QuerySpecification

java.lang.Object
  extended by org.eclipse.wst.jsdt.ui.search.QuerySpecification
Direct Known Subclasses:
ElementQuerySpecification, PatternQuerySpecification

public abstract class QuerySpecification
extends java.lang.Object

Describes a JavaScript search query. A query is described by giving a scope, a scope description, what kind of match to search for (reference, declarations, etc) and either a JavaScript element or a string and what kind of element to search for (type, field, etc). What exactly it means to, for example, to search for "references to type foo" is up to query participants. For example, a participant might consider the "class" attribute of an extension in a plugin.xml file to be a reference to the class mentioned in the attribute.

This class is not intended to be instantiated or subclassed by clients.

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Method Summary
 int getLimitTo()
          Returns what kind of occurrences the query should look for.
 IJavaScriptSearchScope getScope()
          Returns the search scope to be used in the query.
 java.lang.String getScopeDescription()
          Returns a human readable description of the search scope.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getScope

public IJavaScriptSearchScope getScope()
Returns the search scope to be used in the query.

Returns:
The search scope.

getScopeDescription

public java.lang.String getScopeDescription()
Returns a human readable description of the search scope.

Returns:
A description of the search scope.
See Also:
getScope()

getLimitTo

public int getLimitTo()
Returns what kind of occurrences the query should look for.

Returns:
Whether to search for reference, declaration, etc.
See Also:
IJavaScriptSearchConstants