Java Doc for SearchMatch.java in  » IDE-Eclipse » jdt » org » eclipse » jdt » core » search » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.core.search 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.eclipse.jdt.core.search.SearchMatch

All known Subclasses:   org.eclipse.jdt.core.search.TypeParameterReferenceMatch,  org.eclipse.jdt.core.search.MethodReferenceMatch,  org.eclipse.jdt.core.search.LocalVariableReferenceMatch,  org.eclipse.jdt.core.search.TypeParameterDeclarationMatch,  org.eclipse.jdt.core.search.PackageReferenceMatch,  org.eclipse.jdt.core.search.TypeReferenceMatch,  org.eclipse.jdt.core.search.MethodDeclarationMatch,  org.eclipse.jdt.core.search.TypeDeclarationMatch,  org.eclipse.jdt.core.search.LocalVariableDeclarationMatch,  org.eclipse.jdt.core.search.FieldReferenceMatch,  org.eclipse.jdt.core.search.PackageDeclarationMatch,  org.eclipse.jdt.core.search.FieldDeclarationMatch,
SearchMatch
public class SearchMatch (Code)
A search match represents the result of a search query. Search matches may be accurate (A_ACCURATE) or they might be merely potential matches (A_INACCURATE). The latter occurs when a compile-time problem prevents the search engine from completely resolving the match.

This class is intended to be instantiated and subclassed by clients.


See Also:   SearchEngine.search(SearchPatternSearchParticipant[]IJavaSearchScopeSearchRequestororg.eclipse.core.runtime.IProgressMonitor)
since:
   3.0


Field Summary
final public static  intA_ACCURATE
     The search result corresponds an exact match of the search pattern.
final public static  intA_INACCURATE
     The search result is potentially a match for the search pattern, but the search engine is unable to fully check it (for example, because there are errors in the code or the classpath are not correctly set).

Constructor Summary
public  SearchMatch(IJavaElement element, int accuracy, int offset, int length, SearchParticipant participant, IResource resource)
     Creates a new search match.

Method Summary
final public  intgetAccuracy()
     Returns the accuracy of this search match.
final public  ObjectgetElement()
     Returns the element of this search match.
final public  intgetLength()
     Returns the length of this search match.
final public  intgetOffset()
     Returns the offset of this search match.
final public  SearchParticipantgetParticipant()
     Returns the search participant which issued this search match.
final public  IResourcegetResource()
     Returns the resource containing this search match.
final public  intgetRule()
     Returns the rule used while creating the match.
final public  booleanisEquivalent()
     Returns whether match element is compatible with searched pattern or not.
final public  booleanisErasure()
     Returns whether match element only has same erasure than searched pattern or not.
final public  booleanisExact()
     Returns whether element matches exactly searched pattern or not.
final public  booleanisImplicit()
     Returns whether the associated element is implicit or not.
final public  booleanisInsideDocComment()
     Returns whether this search match is inside a doc comment of a Java source file.
final public  booleanisRaw()
     Returns whether the associated element is a raw type/method or not.
final public  voidsetAccuracy(int accuracy)
     Sets the accuracy of this match.
final public  voidsetElement(Object element)
     Sets the element of this search match.
final public  voidsetImplicit(boolean implicit)
     Sets whether the associated element is implicit or not.
final public  voidsetInsideDocComment(boolean insideDoc)
     Sets whether this search match is inside a doc comment of a Java source file.
final public  voidsetLength(int length)
     Sets the length of this search match.
final public  voidsetOffset(int offset)
     Sets the offset of this search match.
final public  voidsetParticipant(SearchParticipant participant)
     Sets the participant of this match.
final public  voidsetRaw(boolean raw)
     Set whether the associated element is a raw type/method or not.
final public  voidsetResource(IResource resource)
     Sets the resource of this match.
final public  voidsetRule(int rule)
     Set the rule used while reporting the match.
public  StringtoString()
    

Field Detail
A_ACCURATE
final public static int A_ACCURATE(Code)
The search result corresponds an exact match of the search pattern.
See Also:   SearchMatch.getAccuracy()



A_INACCURATE
final public static int A_INACCURATE(Code)
The search result is potentially a match for the search pattern, but the search engine is unable to fully check it (for example, because there are errors in the code or the classpath are not correctly set).
See Also:   SearchMatch.getAccuracy()




Constructor Detail
SearchMatch
public SearchMatch(IJavaElement element, int accuracy, int offset, int length, SearchParticipant participant, IResource resource)(Code)
Creates a new search match.

Note that isInsideDocComment() defaults to false.


Parameters:
  element - the element that encloses or corresponds to the match,or null if none
Parameters:
  accuracy - one of SearchMatch.A_ACCURATE or SearchMatch.A_INACCURATE
Parameters:
  offset - the offset the match starts at, or -1 if unknown
Parameters:
  length - the length of the match, or -1 if unknown
Parameters:
  participant - the search participant that created the match
Parameters:
  resource - the resource of the element, or null if none




Method Detail
getAccuracy
final public int getAccuracy()(Code)
Returns the accuracy of this search match. one of SearchMatch.A_ACCURATE or SearchMatch.A_INACCURATE



getElement
final public Object getElement()(Code)
Returns the element of this search match. In case of a reference match, this is the inner-most enclosing element of the reference. In case of a declaration match, this is the declaration. the element of the search match, or null if none



getLength
final public int getLength()(Code)
Returns the length of this search match. the length of this search match, or -1 if unknown



getOffset
final public int getOffset()(Code)
Returns the offset of this search match. the offset of this search match, or -1 if unknown



getParticipant
final public SearchParticipant getParticipant()(Code)
Returns the search participant which issued this search match. the participant which issued this search match



getResource
final public IResource getResource()(Code)
Returns the resource containing this search match. the resource of the match, or null if none



getRule
final public int getRule()(Code)
Returns the rule used while creating the match. one of SearchPattern.R_FULL_MATCH, SearchPattern.R_EQUIVALENT_MATCHor SearchPattern.R_ERASURE_MATCH
since:
   3.1



isEquivalent
final public boolean isEquivalent()(Code)
Returns whether match element is compatible with searched pattern or not. Note that equivalent matches are also erasure ones. true if match element is compatible false otherwise
since:
   3.1



isErasure
final public boolean isErasure()(Code)
Returns whether match element only has same erasure than searched pattern or not. Note that this is always true for both generic and non-generic element as soon as the accuracy is accurate. true if match element has same erasurefalse otherwise
since:
   3.1



isExact
final public boolean isExact()(Code)
Returns whether element matches exactly searched pattern or not. Note that exact matches are also erasure and equivalent ones. true if match is exactfalse otherwise
since:
   3.1



isImplicit
final public boolean isImplicit()(Code)
Returns whether the associated element is implicit or not. Note that this piece of information is currently only implemented for implicit member pair value in annotation. true if this match is associated to an implicitelement and false otherwise
since:
   3.1



isInsideDocComment
final public boolean isInsideDocComment()(Code)
Returns whether this search match is inside a doc comment of a Java source file. true if this search match is inside a doccomment, and false otherwise



isRaw
final public boolean isRaw()(Code)
Returns whether the associated element is a raw type/method or not. true if this match is associated to a rawtype or method and false otherwise
since:
   3.1



setAccuracy
final public void setAccuracy(int accuracy)(Code)
Sets the accuracy of this match.
Parameters:
  accuracy - one of SearchMatch.A_ACCURATE or SearchMatch.A_INACCURATE



setElement
final public void setElement(Object element)(Code)
Sets the element of this search match.
Parameters:
  element - the element that encloses or corresponds to the match,or null if none



setImplicit
final public void setImplicit(boolean implicit)(Code)
Sets whether the associated element is implicit or not. Typically, this is the case when match is on an implicit constructor or an implicit member pair value in annotation.
Parameters:
  implicit - true if this match is associated to an implicitelement and false otherwise
since:
   3.1



setInsideDocComment
final public void setInsideDocComment(boolean insideDoc)(Code)
Sets whether this search match is inside a doc comment of a Java source file.
Parameters:
  insideDoc - true if this search match is inside a doccomment, and false otherwise



setLength
final public void setLength(int length)(Code)
Sets the length of this search match.
Parameters:
  length - the length of the match, or -1 if unknown



setOffset
final public void setOffset(int offset)(Code)
Sets the offset of this search match.
Parameters:
  offset - the offset the match starts at, or -1 if unknown



setParticipant
final public void setParticipant(SearchParticipant participant)(Code)
Sets the participant of this match.
Parameters:
  participant - the search participant that created this match



setRaw
final public void setRaw(boolean raw)(Code)
Set whether the associated element is a raw type/method or not.
Parameters:
  raw - true if this search match is associated to a rawtype or method and false otherwise
since:
   3.1



setResource
final public void setResource(IResource resource)(Code)
Sets the resource of this match.
Parameters:
  resource - the resource of the match, or null if none



setRule
final public void setRule(int rule)(Code)
Set the rule used while reporting the match.
Parameters:
  rule - one of SearchPattern.R_FULL_MATCH, SearchPattern.R_EQUIVALENT_MATCHor SearchPattern.R_ERASURE_MATCH
since:
   3.1



toString
public String toString()(Code)



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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.