org.eclipse.jdt.core.compiler
Class BuildContext

java.lang.Object
  org.eclipse.jdt.internal.core.builder.CompilationParticipantResult
      org.eclipse.jdt.core.compiler.BuildContext

public class BuildContext
extends CompilationParticipantResult

The context of a build event that is notified to interested compilation participants when a build is starting, or to annotations processors when a source file has annotations.

Since:

3.2

Constructor Summary

BuildContext(SourceFile sourceFile)
Creates a build context for the given source file.

Method Summary

char[]	getContents() Returns the contents of the compilation unit.
IFile	getFile() Returns the IFile representing the compilation unit.
boolean	hasAnnotations() Returns whether the compilation unit contained any annotations when it was compiled.
void	recordAddedGeneratedFiles(IFile[] addedGeneratedFiles) Record the added/changed generated files that need to be compiled.
void	recordDeletedGeneratedFiles(IFile[] deletedGeneratedFiles) Record the generated files that need to be deleted.
void	recordDependencies(java.lang.String[] typeNameDependencies) Record the fully-qualified type names of any new dependencies, each name is of the form "p1.p2.A.B".
void	recordNewProblems(CategorizedProblem[] newProblems) Record new problems to report against this compilationUnit.

Methods inherited from class org.eclipse.jdt.internal.core.builder.CompilationParticipantResult

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BuildContext

public BuildContext(SourceFile sourceFile)

Creates a build context for the given source file.

This constructor is not intended to be called by clients.

Parameters:

sourceFile - the source file being built

Method Detail

getContents

public char[] getContents()

Returns the contents of the compilation unit.

Returns:

the contents of the compilation unit

getFile

public IFile getFile()

Returns the IFile representing the compilation unit.

Returns:

the IFile representing the compilation unit

hasAnnotations

public boolean hasAnnotations()

Returns whether the compilation unit contained any annotations when it was compiled. NOTE: This is only valid during CompilationParticipant.processAnnotations(BuildContext[]).

Returns:

whether the compilation unit contained any annotations when it was compiled

recordAddedGeneratedFiles

public void recordAddedGeneratedFiles(IFile[] addedGeneratedFiles)

Record the added/changed generated files that need to be compiled.

Parameters:

addedGeneratedFiles - the added/changed files

recordDeletedGeneratedFiles

public void recordDeletedGeneratedFiles(IFile[] deletedGeneratedFiles)

Record the generated files that need to be deleted.

Parameters:

deletedGeneratedFiles - the files that need to be deleted

recordDependencies

public void recordDependencies(java.lang.String[] typeNameDependencies)

Record the fully-qualified type names of any new dependencies, each name is of the form "p1.p2.A.B".

Parameters:

typeNameDependencies - the fully-qualified type names of new dependencies

recordNewProblems

public void recordNewProblems(CategorizedProblem[] newProblems)

Record new problems to report against this compilationUnit. Markers are persisted for these problems only for the declared managed marker type (see the 'compilationParticipant' extension point).

Parameters:

newProblems - the problems to report