Package org.netbeans.api.java.source

Permits inspection and modification of the structure of Java sources.

See: Description

Interface Summary

Interface	Description
BuildArtifactMapper.ArtifactsUpdated	Notify that the files in the output directory has been updated.
CancellableTask<P>	Cancellable runnable which takes parameter of given type.
ClassIndex.SearchScopeType	Scope used by ClassIndex to search in
ClassIndexListener	Listener for changes in ClassIndex.
ClasspathInfo.Provider	Interface for Tasks that want to provide ClasspathInfo.
ElementUtilities.ElementAcceptor	Filter Elements
Task<P>	Runnable which takes parameter of a given type.

Class Summary

Class	Description
BuildArtifactMapper
ClassIndex	The ClassIndex provides access to information stored in the persistent index.
ClassIndex.Symbols	Description of found symbols (methods, constructors, fields) for one enclosing type.
ClasspathInfo	Class which contains info about classpath
ClasspathInfo.Builder	Builder for ClasspathInfo.
CodeStyle	XXX make sure the getters get the defaults from somewhere XXX add support for profiles XXX get the preferences node from somewhere else in odrer to be able not to use the getters and to be able to write to it.
CodeStyle.ImportGroups	Provides an information about the desired grouping of import statements, including group order.
CodeStyle.MemberGroups	Provides an information about the desired grouping of class members, including group order.
CodeStyleUtils
Comment	An individual comment, consisting of a style, begin and end source file position, the indention (column) of its first character, and its text.
CommentCollector	Deprecated Do not use.
CompilationController	Class for explicit invocation of compilation phases on a java source.
CompilationInfo	Assorted information about the JavaSource.
DocTreePathHandle	Represents a handle for TreePath which can be kept and later resolved by another javac.
ElementHandle<T extends Element>	Represents a handle for Element which can be kept and later resolved by another javac.
ElementUtilities
GeneratorUtilities
JavaParserResultTask<T extends Parser.Result>	Java specific version of the IndexingAwareParserResultTask.
JavaSource	Class representing Java source file opened in the editor.
JavaSourceTaskFactory	A factory for tasks that will be run in the JavaSource Java parsing harness.
ModificationResult	Class that collects changes built during a modification task run.
ModificationResult.Difference
PositionConverter	Binding between virtual Java source and the real source.
RootsEvent	Event used to notify the ClassIndexListener about a change in the underlying ClassPath
ScanUtils	Utility methods, which help JavaSource processing tasks to coordinate with the indexing/scanning process.
SourceUtils
TreeMaker	Factory interface for creating new com.sun.source.tree instances.
TreePathHandle	Represents a handle for TreePath which can be kept and later resolved by another javac.
TreeUtilities
TypeMirrorHandle<T extends TypeMirror>	Represents a handle for TypeMirror which can be kept and later resolved by another javac.
TypesEvent	Event used to notify the ClassIndexListener about a change of declared types in the ClassIndex
TypeUtilities	Various utilities related to the TypeMirrors.
WorkingCopy	XXX: extends CompilationController now, finish method delegation

Enum Summary

Enum	Description
ClassIndex.NameKind	Encodes a type of the name kind used by ClassIndex.getDeclaredTypes(java.lang.String, org.netbeans.api.java.source.ClassIndex.NameKind, java.util.Set<? extends org.netbeans.api.java.source.ClassIndex.SearchScopeType>) method.
ClassIndex.ResourceType	ResourceType used by ClassIndex.getResources(org.netbeans.api.java.source.ElementHandle<javax.lang.model.element.TypeElement>, java.util.Set<org.netbeans.api.java.source.ClassIndex.SearchKind>, java.util.Set<? extends org.netbeans.api.java.source.ClassIndex.SearchScopeType>) to get results in
ClassIndex.SearchKind	Encodes a reference type, used by ClassIndex.getElements(org.netbeans.api.java.source.ElementHandle<javax.lang.model.element.TypeElement>, java.util.Set<org.netbeans.api.java.source.ClassIndex.SearchKind>, java.util.Set<? extends org.netbeans.api.java.source.ClassIndex.SearchScopeType>) and ClassIndex.getResources(org.netbeans.api.java.source.ElementHandle<javax.lang.model.element.TypeElement>, java.util.Set<org.netbeans.api.java.source.ClassIndex.SearchKind>, java.util.Set<? extends org.netbeans.api.java.source.ClassIndex.SearchScopeType>) to restrict the search.
ClassIndex.SearchScope	Default predefined ClassIndex.SearchScopeTypes
ClasspathInfo.PathKind
CodeStyle.BracePlacement
CodeStyle.BracesGenerationStyle
CodeStyle.InsertionPoint
CodeStyle.WrapStyle
Comment.Style	The set of different comment types.
CompilationInfo.CacheClearPolicy	Constants to specify when a valued cached by CompilationInfo.putCachedValue(java.lang.Object, java.lang.Object, org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy) should be evicted from the cache.
JavaSource.Phase
JavaSource.Priority
ModificationResult.Difference.Kind
TypeUtilities.TypeNameOptions	Options for the TypeUtilities.getTypeName(javax.lang.model.type.TypeMirror, org.netbeans.api.java.source.TypeUtilities.TypeNameOptions[]) method.

Exception Summary

Exception	Description
JavaSource.InsufficientMemoryException	This specialization of IOException signals that a JavaSource.runUserActionTask(org.netbeans.api.java.source.Task<org.netbeans.api.java.source.CompilationController>, boolean) or JavaSource.runModificationTask(org.netbeans.api.java.source.Task<org.netbeans.api.java.source.WorkingCopy>) failed due to lack of memory.

Package org.netbeans.api.java.source Description

Permits inspection and modification of the structure of Java sources. Java_DevelopersGuide is a useful resource.