Package com.intellij.codeInsight.actions

Class AbstractLayoutCodeProcessor

java.lang.Object

com.intellij.codeInsight.actions.AbstractLayoutCodeProcessor

Direct Known Subclasses:

CodeCleanupCodeProcessor, OptimizeImportsProcessor, RearrangeCodeProcessor, ReformatCodeProcessor

public abstract class AbstractLayoutCodeProcessor
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractLayoutCodeProcessor	myPreviousCodeProcessor
protected Project	myProject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLayoutCodeProcessor(AbstractLayoutCodeProcessor previous, java.lang.String commandName, java.lang.String progressText)
protected	AbstractLayoutCodeProcessor(Project project, Module module, java.lang.String commandName, java.lang.String progressText, boolean processChangedTextOnly)
protected	AbstractLayoutCodeProcessor(Project project, PsiDirectory directory, boolean includeSubdirs, java.lang.String progressText, java.lang.String commandName, boolean processChangedTextOnly)
protected	AbstractLayoutCodeProcessor(Project project, PsiFile [] files, java.lang.String progressText, java.lang.String commandName, java.lang.Runnable postRunnable, boolean processChangedTextOnly)
protected	AbstractLayoutCodeProcessor(Project project, PsiFile file, java.lang.String progressText, java.lang.String commandName, boolean processChangedTextOnly)
protected	AbstractLayoutCodeProcessor(Project project, java.lang.String commandName, java.lang.String progressText, boolean processChangedTextOnly)

Method Summary

Modifier and Type	Method and Description
void	addFileFilter(VirtualFileFilter filter)
LayoutCodeInfoCollector	getInfoCollector()
protected abstract java.util.concurrent.FutureTask<java.lang.Boolean>	prepareTask(PsiFile file, boolean processChangedTextOnly) Ensures that given file is ready to reformatting and prepares it if necessary.
java.util.concurrent.FutureTask<java.lang.Boolean>	preprocessFile(PsiFile file, boolean processChangedTextOnly) Deprecated. This method incorrectly combines several prepareTask(com.intellij.psi.PsiFile, boolean) results, so that some of them might get outdated after previous results are executed in write action. Use run() or runWithoutProgress() instead.
void	run()
void	runWithoutProgress()
void	setCollectInfo(boolean isCollectInfo)
void	setPostRunnable(java.lang.Runnable postRunnable)

Methods inherited from class java.lang.Object

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

Field Detail

myProject

protected final Project myProject

myPreviousCodeProcessor

protected AbstractLayoutCodeProcessor myPreviousCodeProcessor

Constructor Detail

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(Project project,
                                      java.lang.String commandName,
                                      java.lang.String progressText,
                                      boolean processChangedTextOnly)

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(AbstractLayoutCodeProcessor previous,
                                      java.lang.String commandName,
                                      java.lang.String progressText)

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(Project project,
                                      Module module,
                                      java.lang.String commandName,
                                      java.lang.String progressText,
                                      boolean processChangedTextOnly)

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(Project project,
                                      PsiDirectory directory,
                                      boolean includeSubdirs,
                                      java.lang.String progressText,
                                      java.lang.String commandName,
                                      boolean processChangedTextOnly)

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(Project project,
                                      PsiFile file,
                                      java.lang.String progressText,
                                      java.lang.String commandName,
                                      boolean processChangedTextOnly)

AbstractLayoutCodeProcessor

protected AbstractLayoutCodeProcessor(Project project,
                                      PsiFile [] files,
                                      java.lang.String progressText,
                                      java.lang.String commandName,
                                      java.lang.Runnable postRunnable,
                                      boolean processChangedTextOnly)

Method Detail

setPostRunnable

public void setPostRunnable(java.lang.Runnable postRunnable)

setCollectInfo

public void setCollectInfo(boolean isCollectInfo)

addFileFilter

public void addFileFilter(VirtualFileFilter filter)

prepareTask

protected abstract java.util.concurrent.FutureTask<java.lang.Boolean> prepareTask(PsiFile file,
                                                                                  boolean processChangedTextOnly)
                                                                           throws IncorrectOperationException

Ensures that given file is ready to reformatting and prepares it if necessary.

Parameters:

file - file to process

processChangedTextOnly - flag that defines is only the changed text (in terms of VCS change) should be processed

Returns:

task that triggers formatting of the given file. Returns value of that task indicates whether formatting is finished correctly or not (exception occurred, user cancelled formatting etc)

Throws:

IncorrectOperationException - if unexpected exception occurred during formatting

preprocessFile

@Deprecated
public java.util.concurrent.FutureTask<java.lang.Boolean> preprocessFile(PsiFile file,
                                                                         boolean processChangedTextOnly)
                                                                  throws IncorrectOperationException

Deprecated. This method incorrectly combines several prepareTask(com.intellij.psi.PsiFile, boolean) results, so that some of them might get outdated after previous results are executed in write action. Use run() or runWithoutProgress() instead.

Throws:

IncorrectOperationException

run

public void run()

runWithoutProgress

public void runWithoutProgress()
                        throws IncorrectOperationException

Throws:

IncorrectOperationException

getInfoCollector

public LayoutCodeInfoCollector getInfoCollector()