Package com.intellij.task

Class ProjectTaskContext

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.task.ProjectTaskContext

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

public class ProjectTaskContext
extends UserDataHolderBase

Constructor Summary

Constructors

Constructor and Description
ProjectTaskContext()
ProjectTaskContext(boolean autoRun)
ProjectTaskContext(java.lang.Object sessionId)
ProjectTaskContext(java.lang.Object sessionId, RunConfiguration runConfiguration)
ProjectTaskContext(java.lang.Object sessionId, RunConfiguration runConfiguration, boolean autoRun)

Method Summary

Modifier and Type	Method and Description
void	addDirtyOutputPathsProvider(java.util.function.Supplier<? extends java.util.Collection<java.lang.String>> outputPathsProvider) This method isn't supposed to be used directly.
void	enableCollectionOfGeneratedFiles()
void	fileGenerated(java.lang.String root, java.lang.String relativePath) This method isn't supposed to be used directly.
java.util.Optional<java.util.stream.Stream<java.lang.String>>	getDirtyOutputPaths() Provides output paths that can be used for generated files by some tasks.
java.util.Collection<java.lang.String>	getGeneratedFilesRelativePaths(java.lang.String root) Returns files generated during the task session in the specified root.
java.util.Collection<java.lang.String>	getGeneratedFilesRoots() Returns roots of the files generated during the task session.
RunConfiguration	getRunConfiguration()
java.lang.Object	getSessionId()
boolean	isAutoRun()
boolean	isCollectionOfGeneratedFilesEnabled()
<T> ProjectTaskContext	withUserData(Key<T> key, T value)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectTaskContext

public ProjectTaskContext()

ProjectTaskContext

public ProjectTaskContext(boolean autoRun)

ProjectTaskContext

public ProjectTaskContext(java.lang.Object sessionId)

ProjectTaskContext

public ProjectTaskContext(java.lang.Object sessionId,
                          RunConfiguration runConfiguration)

ProjectTaskContext

public ProjectTaskContext(java.lang.Object sessionId,
                          RunConfiguration runConfiguration,
                          boolean autoRun)

Method Detail

getSessionId

public java.lang.Object getSessionId()

getRunConfiguration

public RunConfiguration getRunConfiguration()

isAutoRun

public boolean isAutoRun()

Returns:

true indicates that the task was started automatically, e.g. resources compilation on frame deactivation

enableCollectionOfGeneratedFiles

public void enableCollectionOfGeneratedFiles()

isCollectionOfGeneratedFilesEnabled

public boolean isCollectionOfGeneratedFilesEnabled()

getGeneratedFilesRoots

public java.util.Collection<java.lang.String> getGeneratedFilesRoots()

Returns roots of the files generated during the task session. Note, generated files collecting is disabled by default. It can be requested using the enableCollectionOfGeneratedFiles() method by the task initiator, see ProjectTaskManager.run(ProjectTaskContext, ProjectTask). Or using the ProjectTaskListener.started(ProjectTaskContext) event.

getGeneratedFilesRelativePaths

public java.util.Collection<java.lang.String> getGeneratedFilesRelativePaths(java.lang.String root)

Returns files generated during the task session in the specified root. Note, generated files collecting is disabled by default. It can be requested using the enableCollectionOfGeneratedFiles() method by the task initiator, see ProjectTaskManager.run(ProjectTaskContext, ProjectTask). Or using the ProjectTaskListener.started(ProjectTaskContext) event.

fileGenerated

public void fileGenerated(java.lang.String root,
                          java.lang.String relativePath)

This method isn't supposed to be used directly. ProjectTaskRunners can use it to report information about generated files during some task execution.

Parameters:

root - the root directory of the generated file

relativePath - the generated file relative path with regard to the root

addDirtyOutputPathsProvider

public void addDirtyOutputPathsProvider(java.util.function.Supplier<? extends java.util.Collection<java.lang.String>> outputPathsProvider)

This method isn't supposed to be used directly. ProjectTaskRunners can use it to report output paths of generated files produced during some task execution.

Note, generated files collecting is disabled by default. It can be requested using the enableCollectionOfGeneratedFiles() method by the task initiator, see ProjectTaskManager.run(ProjectTaskContext, ProjectTask). Or using the ProjectTaskListener.started(ProjectTaskContext) event.

The method should be used ONLY if the ProjectTaskRunner doesn't support fileGenerated(java.lang.String, java.lang.String) events.

getDirtyOutputPaths

public java.util.Optional<java.util.stream.Stream<java.lang.String>> getDirtyOutputPaths()

Provides output paths that can be used for generated files by some tasks. The intended usage is to scan those directories for modified files.

Can be useful for ProjectTaskRunners which doesn't support fileGenerated(java.lang.String, java.lang.String) events.

withUserData

public <T> ProjectTaskContext withUserData(Key<T> key,
                                           T value)