Java Doc for RefactoringSearchEngine2.java in » IDE-Eclipse » jdt » org » eclipse » jdt » internal » corext » refactoring » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » jdt » org.eclipse.jdt.internal.corext.refactoring

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.jdt.internal.corext.refactoring .RefactoringSearchEngine2

RefactoringSearchEngine2
final public class RefactoringSearchEngine2 (Code)
	Helper class to use the search engine in refactorings. since: 3.1

Field Summary
final public static int	GRANULARITY_COMPILATION_UNIT
final public static int	GRANULARITY_SEARCH_MATCH

Constructor Summary
public	RefactoringSearchEngine2() Creates a new refactoring search engine.
public	RefactoringSearchEngine2(SearchPattern pattern) Creates a new refactoring search engine.

Method Summary
final public void	clearResults() Clears all results found so far, and sets resets the status to RefactoringStatus.OK .
final public ICompilationUnit[]	getAffectedCompilationUnits() Returns the affected compilation units of the previous search queries.
final public Map	getAffectedProjects() Returns the affected java projects of the previous search queries.
final public SearchPattern	getPattern() Returns the search pattern currently used for searching.
final public Object[]	getResults() Returns the results of the previous search queries.
final public RefactoringStatus	getStatus() Returns the refactoring status of this search engine.
final public void	searchPattern(IProgressMonitor monitor) Performs the search according to the specified pattern.
final public void	searchReferencedFields(IJavaElement element, IProgressMonitor monitor) Performs the search of referenced fields.
final public void	searchReferencedMethods(IJavaElement element, IProgressMonitor monitor) Performs the search of referenced methods.
final public void	searchReferencedTypes(IJavaElement element, IProgressMonitor monitor) Performs the search of referenced types.
final public void	setFiltering(boolean inaccurate, boolean binary) Determines how search matches are filtered. This method must be called before start searching.
final public void	setGranularity(int granularity) Sets the granularity to use during the searches. This method must be called before start searching.
final public void	setGrouping(boolean grouping) Determines how search matches are grouped. This method must be called before start searching.
final public void	setOrPattern(SearchPattern first, SearchPattern second) Sets the disjunction of search patterns to be used during search.
final public void	setOwner(WorkingCopyOwner owner) Sets the working copy owner to use during search. This method must be called before start searching.
final public void	setPattern(IJavaElement[] elements, int limitTo) Sets the search pattern to be used during search. This method must be called before RefactoringSearchEngine2.searchPattern(IProgressMonitor) Parameters: elements - the set of elements Parameters: limitTo - determines the nature of the expected matches.
final public void	setPattern(SearchPattern pattern) Sets the search pattern to be used during search.
final public void	setRequestor(IRefactoringSearchRequestor requestor) Sets the search requestor for this search engine. This method must be called before start searching.
final public void	setScope(IJavaSearchScope scope) Sets the search scope for this search engine. This method must be called before start searching.
final public void	setSeverity(int severity) Sets the severity of the generated status entries. This method must be called before start searching.
final public void	setStatus(RefactoringStatus status) Sets the refactoring status for this search engine. This method must be called before start searching.
final public void	setWorkingCopies(ICompilationUnit[] copies) Sets the working copies to take precedence during the searches. This method must be called before start searching.

Field Detail

GRANULARITY_COMPILATION_UNIT
final public static int GRANULARITY_COMPILATION_UNIT(Code)
	The compilation unit granularity

GRANULARITY_SEARCH_MATCH
final public static int GRANULARITY_SEARCH_MATCH(Code)
	The search match granularity

Constructor Detail

RefactoringSearchEngine2
public RefactoringSearchEngine2()(Code)
	Creates a new refactoring search engine.

RefactoringSearchEngine2
public RefactoringSearchEngine2(SearchPattern pattern)(Code)
	Creates a new refactoring search engine. Parameters: pattern - the search pattern

Method Detail

clearResults
final public void clearResults()(Code)
	Clears all results found so far, and sets resets the status to RefactoringStatus.OK .

getAffectedCompilationUnits
final public ICompilationUnit[] getAffectedCompilationUnits()(Code)
	Returns the affected compilation units of the previous search queries. In order to retrieve the compilation units, grouping by resource must have been enabled before searching. the compilation units of the previous queries

getAffectedProjects
final public Map getAffectedProjects()(Code)
	Returns the affected java projects of the previous search queries. In order to retrieve the java projects, grouping by resource must have been enabled before searching. the java projects of the previous queries (element type: `<IJavaProject, Collection<SearchResultGroup>>`)

getPattern
final public SearchPattern getPattern()(Code)
	Returns the search pattern currently used for searching. the search pattern

getResults

final public Object[] getResults()(Code)

Returns the results of the previous search queries.

The result depends on the following conditions:

If the search granularity is RefactoringSearchEngine2.GRANULARITY_COMPILATION_UNIT , the results are elements of type ICompilationUnit .
If grouping by resource is enabled, the results are elements of type SearchResultGroup , otherwise the elements are of type SearchMatch .

the results of the previous queries

getStatus
final public RefactoringStatus getStatus()(Code)
	Returns the refactoring status of this search engine. the refactoring status

searchPattern
final public void searchPattern(IProgressMonitor monitor) throws JavaModelException(Code)
	Performs the search according to the specified pattern. Parameters: monitor - the progress monitor, or `null` throws: JavaModelException - if an error occurs during search

searchReferencedFields
final public void searchReferencedFields(IJavaElement element, IProgressMonitor monitor) throws JavaModelException(Code)
	Performs the search of referenced fields. Parameters: element - the java element whose referenced fields have to be found Parameters: monitor - the progress monitor, or `null` throws: JavaModelException - if an error occurs during search

searchReferencedMethods
final public void searchReferencedMethods(IJavaElement element, IProgressMonitor monitor) throws JavaModelException(Code)
	Performs the search of referenced methods. Parameters: element - the java element whose referenced methods have to be found Parameters: monitor - the progress monitor, or `null` throws: JavaModelException - if an error occurs during search

searchReferencedTypes
final public void searchReferencedTypes(IJavaElement element, IProgressMonitor monitor) throws JavaModelException(Code)
	Performs the search of referenced types. Parameters: element - the java element whose referenced types have to be found Parameters: monitor - the progress monitor, or `null` throws: JavaModelException - if an error occurs during search

setFiltering
final public void setFiltering(boolean inaccurate, boolean binary)(Code)
	Determines how search matches are filtered. This method must be called before start searching. The default is to filter inaccurate matches only. Parameters: inaccurate - `true` to filter inaccurate matches, `false` otherwise Parameters: binary - `true` to filter binary matches, `false` otherwise

setGranularity
final public void setGranularity(int granularity)(Code)
	Sets the granularity to use during the searches. This method must be called before start searching. The default is a granularity of RefactoringSearchEngine2.GRANULARITY_SEARCH_MATCH . Parameters: granularity - The granularity to use. Must be one of the `GRANULARITY_XXX` constants.

setGrouping
final public void setGrouping(boolean grouping)(Code)
	Determines how search matches are grouped. This method must be called before start searching. The default is to group by containing resource. Parameters: grouping - `true` to group matches by their containing resource, `false` otherwise

setOrPattern
final public void setOrPattern(SearchPattern first, SearchPattern second)(Code)
	Sets the disjunction of search patterns to be used during search. This method must be called before RefactoringSearchEngine2.searchPattern(IProgressMonitor) Parameters: first - the first search pattern to set Parameters: second - the second search pattern to set

setOwner
final public void setOwner(WorkingCopyOwner owner)(Code)
	Sets the working copy owner to use during search. This method must be called before start searching. The default is to use no working copy owner. Parameters: owner - the working copy owner to use, or `null` to use none

setPattern
final public void setPattern(IJavaElement[] elements, int limitTo)(Code)
	Sets the search pattern to be used during search. This method must be called before RefactoringSearchEngine2.searchPattern(IProgressMonitor) Parameters: elements - the set of elements Parameters: limitTo - determines the nature of the expected matches. This is a combination of org.eclipse.jdt.core.search.IJavaSearchConstants.

setPattern
final public void setPattern(SearchPattern pattern)(Code)
	Sets the search pattern to be used during search. This method must be called before RefactoringSearchEngine2.searchPattern(IProgressMonitor) Parameters: pattern - the search pattern to set

setRequestor
final public void setRequestor(IRefactoringSearchRequestor requestor)(Code)
	Sets the search requestor for this search engine. This method must be called before start searching. The default is a non-filtering search requestor. Parameters: requestor - the search requestor to set

setScope
final public void setScope(IJavaSearchScope scope)(Code)
	Sets the search scope for this search engine. This method must be called before start searching. The default is the entire workspace as search scope. Parameters: scope - the search scope to set

setSeverity
final public void setSeverity(int severity)(Code)
	Sets the severity of the generated status entries. This method must be called before start searching. The default is a severity of RefactoringStatus.OK . Parameters: severity - the severity to set

setStatus
final public void setStatus(RefactoringStatus status)(Code)
	Sets the refactoring status for this search engine. This method must be called before start searching. The default is an empty status with status RefactoringStatus.OK . Parameters: status - the refactoring status to set

setWorkingCopies
final public void setWorkingCopies(ICompilationUnit[] copies)(Code)
	Sets the working copies to take precedence during the searches. This method must be called before start searching. The default is to use no working copies Parameters: copies - the working copies to use

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.