Package com.intellij.openapi.command

Class WriteCommandAction<T>

java.lang.Object

com.intellij.openapi.application.BaseActionRunnable<T>

com.intellij.openapi.command.WriteCommandAction<T>

Direct Known Subclasses:

WriteCommandAction.Simple

public abstract class WriteCommandAction<T>
extends BaseActionRunnable<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WriteCommandAction.Builder
static class	WriteCommandAction.Simple<T> Deprecated. Use writeCommandAction(Project).run() or .compute() instead

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriteCommandAction(Project project, PsiFile... files) Deprecated. Use writeCommandAction(Project, PsiFile...).run() instead
protected	WriteCommandAction(Project project, java.lang.String commandName, PsiFile... files) Deprecated. Use writeCommandAction(Project, PsiFile...).withName(commandName).run() instead
protected	WriteCommandAction(Project project, java.lang.String commandName, java.lang.String groupID, PsiFile... files) Deprecated. Use writeCommandAction(Project, PsiFile...).withName(commandName).withGroupId(groupID).run() instead

Method Summary

Modifier and Type	Method and Description
RunResult<T>	execute() Deprecated. Use #writeCommandAction(Project).run() or compute() instead
java.lang.String	getCommandName()
java.lang.String	getGroupID()
Project	getProject()
protected UndoConfirmationPolicy	getUndoConfirmationPolicy() Deprecated. Use writeCommandAction(Project).withUndoConfirmationPolicy() instead
protected boolean	isGlobalUndoAction() Deprecated. Use writeCommandAction(Project).withGlobalUndo() instead
void	performCommand() Deprecated. Use CommandProcessor.executeCommand(Project, Runnable, String, Object) instead
static <T> T	runWriteCommandAction(Project project, Computable<T> computable)
static void	runWriteCommandAction(Project project, java.lang.Runnable runnable) If run a write command using this method then "Undo" action always shows "Undefined" text - DEFAULT_COMMAND_NAME.
static void	runWriteCommandAction(Project project, java.lang.String commandName, java.lang.String groupID, java.lang.Runnable runnable, PsiFile... files)
static <T,E extends java.lang.Throwable> T	runWriteCommandAction(Project project, ThrowableComputable<T,E> computable)
protected boolean	shouldRecordActionForActiveDocument() Deprecated. Use writeCommandAction(Project).shouldRecordActionForActiveDocument() instead
static WriteCommandAction.Builder	writeCommandAction(Project project)
static WriteCommandAction.Builder	writeCommandAction(Project project, PsiFile... files)
static WriteCommandAction.Builder	writeCommandAction(PsiFile first, PsiFile... others)

Methods inherited from class com.intellij.openapi.application.BaseActionRunnable

executeSilently, isSilentExecution, run

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteCommandAction

@Deprecated
protected WriteCommandAction(Project project,
                             PsiFile... files)

Deprecated. Use writeCommandAction(Project, PsiFile...).run() instead

WriteCommandAction

@Deprecated
protected WriteCommandAction(Project project,
                             java.lang.String commandName,
                             PsiFile... files)

Deprecated. Use writeCommandAction(Project, PsiFile...).withName(commandName).run() instead

WriteCommandAction

@Deprecated
protected WriteCommandAction(Project project,
                             java.lang.String commandName,
                             java.lang.String groupID,
                             PsiFile... files)

Deprecated. Use writeCommandAction(Project, PsiFile...).withName(commandName).withGroupId(groupID).run() instead

Method Detail

writeCommandAction

public static WriteCommandAction.Builder writeCommandAction(Project project)

writeCommandAction

public static WriteCommandAction.Builder writeCommandAction(PsiFile first,
                                                            PsiFile... others)

writeCommandAction

public static WriteCommandAction.Builder writeCommandAction(Project project,
                                                            PsiFile... files)

getProject

public final Project getProject()

getCommandName

public final java.lang.String getCommandName()

getGroupID

public java.lang.String getGroupID()

execute

@Deprecated
public RunResult<T> execute()

Deprecated. Use #writeCommandAction(Project).run() or compute() instead

Specified by:

execute in class BaseActionRunnable<T>

isGlobalUndoAction

@Deprecated
protected boolean isGlobalUndoAction()

Deprecated. Use writeCommandAction(Project).withGlobalUndo() instead

getUndoConfirmationPolicy

@Deprecated
protected UndoConfirmationPolicy getUndoConfirmationPolicy()

Deprecated. Use writeCommandAction(Project).withUndoConfirmationPolicy() instead

See CommandProcessor.executeCommand(Project, Runnable, String, Object, UndoConfirmationPolicy, boolean) for details.

shouldRecordActionForActiveDocument

@Deprecated
protected boolean shouldRecordActionForActiveDocument()

Deprecated. Use writeCommandAction(Project).shouldRecordActionForActiveDocument() instead

See CommandProcessor.executeCommand(Project, Runnable, String, Object, UndoConfirmationPolicy, boolean) for details.

performCommand

@Deprecated
public void performCommand()
                    throws java.lang.Throwable

Deprecated. Use CommandProcessor.executeCommand(Project, Runnable, String, Object) instead

Throws:

java.lang.Throwable

runWriteCommandAction

public static void runWriteCommandAction(Project project,
                                         java.lang.Runnable runnable)

If run a write command using this method then "Undo" action always shows "Undefined" text - DEFAULT_COMMAND_NAME. Please use runWriteCommandAction(Project, String, String, Runnable, PsiFile...) instead.

runWriteCommandAction

public static void runWriteCommandAction(Project project,
                                         java.lang.String commandName,
                                         java.lang.String groupID,
                                         java.lang.Runnable runnable,
                                         PsiFile... files)

runWriteCommandAction

public static <T> T runWriteCommandAction(Project project,
                                          Computable<T> computable)

runWriteCommandAction

public static <T,E extends java.lang.Throwable> T runWriteCommandAction(Project project,
                                                                        ThrowableComputable<T,E> computable)
                                                                 throws E extends java.lang.Throwable

Throws:

E extends java.lang.Throwable