Package com.intellij.openapi.compiler

Class DummyCompileContext

java.lang.Object

com.intellij.openapi.compiler.DummyCompileContext

All Implemented Interfaces:

CompileContext, UserDataHolder

public class DummyCompileContext
extends java.lang.Object
implements CompileContext

Constructor Summary

Constructors

Modifier	Constructor and Description
	DummyCompileContext() Deprecated. use create(Project) instead
protected	DummyCompileContext(Project project)

Method Summary

Modifier and Type	Method and Description
void	addMessage(CompilerMessageCategory category, java.lang.String message, java.lang.String url, int lineNum, int columnNum) Allows to add a message to be shown in Compiler message view.
void	addMessage(CompilerMessageCategory category, java.lang.String message, java.lang.String url, int lineNum, int columnNum, Navigatable navigatable) Allows to add a message to be shown in Compiler message view, with a specified Navigatable that is used to navigate to the error location.
static DummyCompileContext	create(Project project)
CompileScope	getCompileScope() Returns the current compile scope.
static DummyCompileContext	getInstance() Deprecated. use create(Project) instead
int	getMessageCount(CompilerMessageCategory category) Returns the count of messages of the specified category added during the current compile session.
CompilerMessage []	getMessages(CompilerMessageCategory category) Returns all messages of the specified category added during the current compile session.
Module	getModuleByFile(VirtualFile file) Returns the module to which the specified file belongs.
VirtualFile	getModuleOutputDirectory(Module module) Returns the output directory for the specified module.
VirtualFile	getModuleOutputDirectoryForTests(Module module) Returns the test output directory for the specified module.
ProgressIndicator	getProgressIndicator() Returns the progress indicator of the compilation process.
Project	getProject()
CompileScope	getProjectCompileScope() Returns the compile scope which would be used if the entire project was rebuilt.
java.lang.String	getRebuildReason()
<T> T	getUserData(Key<T> key)
boolean	isAnnotationProcessorsEnabled()
boolean	isAutomake()
boolean	isMake() Checks if the compilation is incremental, i.e.
boolean	isRebuild()
boolean	isRebuildRequested()
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
void	requestRebuildNextTime(java.lang.String message) A compiler may call this method in order to request complete project rebuild.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DummyCompileContext

@Deprecated
public DummyCompileContext()

Deprecated. use create(Project) instead

DummyCompileContext

protected DummyCompileContext(Project project)

Method Detail

getInstance

@Deprecated
public static DummyCompileContext getInstance()

Deprecated. use create(Project) instead

Returns:

create

public static DummyCompileContext create(Project project)

getProject

public Project getProject()

Specified by:

getProject in interface CompileContext

addMessage

public void addMessage(CompilerMessageCategory category,
                       java.lang.String message,
                       java.lang.String url,
                       int lineNum,
                       int columnNum)

Description copied from interface: CompileContext

Allows to add a message to be shown in Compiler message view. If correct url, line and column numbers are supplied, the navigation to the specified file is available from the view.

Specified by:

addMessage in interface CompileContext

Parameters:

category - the category of a message (information, error, warning).

message - the text of the message.

url - a url to the file to which the message applies, null if not available.

lineNum - a line number, -1 if not available.

columnNum - a column number, -1 if not available.

addMessage

public void addMessage(CompilerMessageCategory category,
                       java.lang.String message,
                       java.lang.String url,
                       int lineNum,
                       int columnNum,
                       Navigatable navigatable)

Description copied from interface: CompileContext

Allows to add a message to be shown in Compiler message view, with a specified Navigatable that is used to navigate to the error location.

Specified by:

addMessage in interface CompileContext

Parameters:

category - the category of a message (information, error, warning).

message - the text of the message.

url - a url to the file to which the message applies, null if not available.

lineNum - a line number, -1 if not available.

columnNum - a column number, -1 if not available.

navigatable - the navigatable pointing to the error location.

getMessages

public CompilerMessage [] getMessages(CompilerMessageCategory category)

Description copied from interface: CompileContext

Returns all messages of the specified category added during the current compile session.

Specified by:

getMessages in interface CompileContext

Parameters:

category - the category for which messages are requested.

Returns:

all compiler messages of the specified category

getMessageCount

public int getMessageCount(CompilerMessageCategory category)

Description copied from interface: CompileContext

Returns the count of messages of the specified category added during the current compile session.

Specified by:

getMessageCount in interface CompileContext

Parameters:

category - the category for which messages are requested.

Returns:

the number of messages of the specified category

getProgressIndicator

public ProgressIndicator getProgressIndicator()

Description copied from interface: CompileContext

Returns the progress indicator of the compilation process.

Specified by:

getProgressIndicator in interface CompileContext

Returns:

the progress indicator instance.

getCompileScope

public CompileScope getCompileScope()

Description copied from interface: CompileContext

Returns the current compile scope.

Specified by:

getCompileScope in interface CompileContext

Returns:

current compile scope

getProjectCompileScope

public CompileScope getProjectCompileScope()

Description copied from interface: CompileContext

Returns the compile scope which would be used if the entire project was rebuilt. CompileContext.getCompileScope() may return the scope, that is more narrow than ProjectCompileScope.

Specified by:

getProjectCompileScope in interface CompileContext

Returns:

project-wide compile scope.

requestRebuildNextTime

public void requestRebuildNextTime(java.lang.String message)

Description copied from interface: CompileContext

A compiler may call this method in order to request complete project rebuild. This may be necessary, for example, when compiler caches are corrupted.

Specified by:

requestRebuildNextTime in interface CompileContext

isRebuildRequested

public boolean isRebuildRequested()

Specified by:

isRebuildRequested in interface CompileContext

getRebuildReason

public java.lang.String getRebuildReason()

Specified by:

getRebuildReason in interface CompileContext

getModuleByFile

public Module getModuleByFile(VirtualFile file)

Description copied from interface: CompileContext

Returns the module to which the specified file belongs. This method is aware of the file->module mapping for generated files.

Specified by:

getModuleByFile in interface CompileContext

Parameters:

file - the file to check.

Returns:

the module to which the file belongs

isAnnotationProcessorsEnabled

public boolean isAnnotationProcessorsEnabled()

Specified by:

isAnnotationProcessorsEnabled in interface CompileContext

getModuleOutputDirectory

public VirtualFile getModuleOutputDirectory(Module module)

Description copied from interface: CompileContext

Returns the output directory for the specified module.

Specified by:

getModuleOutputDirectory in interface CompileContext

Parameters:

module - the module to check.

Returns:

the output directory for the module specified, null if corresponding VirtualFile is not valid or directory not specified

getModuleOutputDirectoryForTests

public VirtualFile getModuleOutputDirectoryForTests(Module module)

Description copied from interface: CompileContext

Returns the test output directory for the specified module.

Specified by:

getModuleOutputDirectoryForTests in interface CompileContext

Parameters:

module - the module to check.

Returns:

the tests output directory the module specified, null if corresponding VirtualFile is not valid. If in Paths settings output directory for tests is not configured explicitly, but the output path is present, the output path will be returned.

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

isMake

public boolean isMake()

Description copied from interface: CompileContext

Checks if the compilation is incremental, i.e. triggered by one of "Make" actions.

Specified by:

isMake in interface CompileContext

Returns:

true if compilation is incremental.

isAutomake

public boolean isAutomake()

Specified by:

isAutomake in interface CompileContext

isRebuild

public boolean isRebuild()

Specified by:

isRebuild in interface CompileContext