当前页面: 在线文档首页 > NetBeans API Javadoc (Current Development Version)

SourceUtils (Java Source) - NetBeans API Javadoc (Current Development Version)

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		org.netbeans.modules.java.source 0.13.0 1
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.netbeans.api.java.source
Class SourceUtils

java.lang.Object
  org.netbeans.api.java.source.SourceUtils

---

public class SourceUtils
extends Object

---

Method Summary
static CompilationUnitTree	addImports(CompilationUnitTree cut, List<String> toImport, TreeMaker make)
static boolean	checkTypesAssignable(CompilationInfo info, TypeMirror from, TypeMirror to)
static TypeMirror	getBound(WildcardType wildcardType)
static Set<URL>	getDependentRoots(URL root)           Returns the dependent source path roots for given source root.
static TypeElement	getEnclosingTypeElement(Element element)           Returns the type element within which this member or constructor is declared.
static FileObject	getFile(Element element)           Returns a FileObject in which the Element is defined.
static FileObject	getFile(Element element, ClasspathInfo cpInfo)           Returns a FileObject in which the Element is defined.
static FileObject	getFile(ElementHandle<? extends Element> handle, ClasspathInfo cpInfo)           Returns a FileObject of the source file in which the handle is declared.
static Element	getImplementationOf(CompilationInfo info, ExecutableElement method, TypeElement origin)
static URL	getJavadoc(Element element, ClasspathInfo cpInfo)           Finds URL of a javadoc page for given element when available.
static Collection<ElementHandle<TypeElement>>	getMainClasses(FileObject fo)           Returns classes declared in the given source file which have the main method.
static Collection<ElementHandle<TypeElement>>	getMainClasses(FileObject[] sourceRoots)           Returns classes declared under the given source roots which have the main method.
static TypeElement	getOutermostEnclosingTypeElement(Element element)
static boolean	isMainClass(String qualifiedName, ClasspathInfo cpInfo)           Returns true when the class contains main method.
static boolean	isMainMethod(ExecutableElement method)           Returns true if the method is a main method
static boolean	isScanInProgress()           Tests whether the initial scan is in progress.
static TreePath	pathFor(CompilationInfo info, Element element)           Deprecated. Use Trees.getPath(Element) instead.
static String	resolveImport(CompilationInfo info, TreePath context, String fqn)           Resolve full qualified name in the given context.
static Tree	treeFor(CompilationInfo info, Element element)           Deprecated. Use Trees.getTree(Element) instead.
static void	waitScanFinished()           Waits for the end of the initial scan, this helper method is designed for tests which require to wait for end of initial scan.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

treeFor

public static Tree treeFor(CompilationInfo info,
                           Element element)

Deprecated. Use Trees.getTree(Element) instead.

---

pathFor

public static TreePath pathFor(CompilationInfo info,
                               Element element)

Deprecated. Use Trees.getPath(Element) instead.

---

getImplementationOf

public static Element getImplementationOf(CompilationInfo info,
                                          ExecutableElement method,
                                          TypeElement origin)

---

checkTypesAssignable

public static boolean checkTypesAssignable(CompilationInfo info,
                                           TypeMirror from,
                                           TypeMirror to)

---

getBound

public static TypeMirror getBound(WildcardType wildcardType)

---

getEnclosingTypeElement

public static TypeElement getEnclosingTypeElement(Element element)
                                           throws IllegalArgumentException

Returns the type element within which this member or constructor is declared. Does not accept pakages If this is the declaration of a top-level type (a non-nested class or interface), returns null.

Returns:

the type declaration within which this member or constructor is declared, or null if there is none

Throws:

IllegalArgumentException - if the provided element is a package element

---

getOutermostEnclosingTypeElement

public static TypeElement getOutermostEnclosingTypeElement(Element element)

---

resolveImport

public static String resolveImport(CompilationInfo info,
                                   TreePath context,
                                   String fqn)
                            throws NullPointerException,
                                   IOException

Resolve full qualified name in the given context. Adds import statement as necessary. Returns name that resolved to a given FQN in given context (either simple name or full qualified name). Handles import conflicts.
Note: if the info passed to this method is not an instance of WorkingCopy, missing import statement is added from a separate modification task executed asynchronously.
Note: after calling this method, it is not permitted to rewrite copy.getCompilationUnit().

Parameters:

info - CompilationInfo over which the method should work

context - in which the fully qualified should be resolved

fqn - the fully qualified name to resolve

Returns:

either a simple name or a FQN that will resolve to given fqn in given context

Throws:

NullPointerException

IOException

---

addImports

public static CompilationUnitTree addImports(CompilationUnitTree cut,
                                             List<String> toImport,
                                             TreeMaker make)
                                      throws IOException

Throws:

IOException

---

getFile

public static FileObject getFile(Element element)

Returns a FileObject in which the Element is defined. Element must be defined in source file

Parameters:

element - for which the FileObject should be located

Returns:

the defining FileObject or null if it cannot be found in any source file.

---

getFile

public static FileObject getFile(Element element,
                                 ClasspathInfo cpInfo)

Returns a FileObject in which the Element is defined.

Parameters:

element - for which the FileObject should be located

cpInfo - the classpaths context

Returns:

the defining FileObject or null if it cannot be found

---

getFile

public static FileObject getFile(ElementHandle<? extends Element> handle,
                                 ClasspathInfo cpInfo)

Returns a FileObject of the source file in which the handle is declared.

Parameters:

handle - to find the FileObject for

cpInfo - classpaths for resolving handle

Returns:

FileObject or null when the source file cannot be found

---

getJavadoc

public static URL getJavadoc(Element element,
                             ClasspathInfo cpInfo)

Finds URL of a javadoc page for given element when available. This method uses JavadocForBinaryQuery to find the javadoc page for the give element. For PackageElement it returns the package-summary.html for given package.

Parameters:

element - to find the Javadoc for

cpInfo - classpaths used to resolve

Returns:

the URL of the javadoc page or null when the javadoc is not available.

---

isScanInProgress

public static boolean isScanInProgress()

Tests whether the initial scan is in progress.

---

waitScanFinished

public static void waitScanFinished()
                             throws InterruptedException

Waits for the end of the initial scan, this helper method is designed for tests which require to wait for end of initial scan.

Throws:

InterruptedException - is thrown when the waiting thread is interrupted.

---

getDependentRoots

public static Set<URL> getDependentRoots(URL root)

Returns the dependent source path roots for given source root. It returns all the open project source roots which have either direct or transitive dependency on the given source root.

Parameters:

root - to find the dependent roots for

Returns:

Set of URLs containinig at least the incomming root, never returns null.

Since:

0.10

---

getMainClasses

public static Collection<ElementHandle<TypeElement>> getMainClasses(FileObject fo)

Returns classes declared in the given source file which have the main method.

Parameters:

fo - source file

Returns:

the classes containing main method

Throws:

IllegalArgumentException - when file does not exist or is not a java source file.

---

isMainClass

public static boolean isMainClass(String qualifiedName,
                                  ClasspathInfo cpInfo)

Returns true when the class contains main method.

Parameters:

qualifiedName - the fully qualified name of class

cpInfo - the classpath used to resolve the class

Returns:

true when the class contains a main method

---

isMainMethod

public static boolean isMainMethod(ExecutableElement method)

Returns true if the method is a main method

Parameters:

method - to be checked

Returns:

true when the method is a main method

---

getMainClasses

public static Collection<ElementHandle<TypeElement>> getMainClasses(FileObject[] sourceRoots)

Returns classes declared under the given source roots which have the main method.

Parameters:

sourceRoots - the source roots

Returns:

the classes containing the main methods Currently this method is not optimized and may be slow

---

Overview  Package   Class  Use  Tree  Deprecated  Index  Help		org.netbeans.modules.java.source 0.13.0 1
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Built on May 28 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.