Package com.intellij.codeInsight.generation.surroundWith

Class JavaWithDoWhileSurrounder

java.lang.Object

com.intellij.codeInsight.generation.surroundWith.JavaWithDoWhileSurrounder

All Implemented Interfaces:

Surrounder

public class JavaWithDoWhileSurrounder
extends java.lang.Object

Field Summary

Fields inherited from interface com.intellij.lang.surroundWith.Surrounder

EMPTY_ARRAY, myArrayFactory

Constructor Summary

Constructors

Constructor and Description
JavaWithDoWhileSurrounder()

Method Summary

Modifier and Type	Method and Description
protected PsiStatement	addAfter(PsiStatement statement, PsiElement container, PsiElement[] statements)
protected static void	addCodeBlockContents(PsiCodeBlock codeBlock, PsiBlockStatement statement)
protected static void	addRangeWithinContainer(PsiCodeBlock codeBlock, PsiElement container, PsiElement[] statements, boolean canBreak)
java.lang.String	getTemplateDescription() Returns the user-visible name of the Surround With template.
boolean	isApplicable(PsiElement [] elements) Checks if the template can be used to surround the specified range of elements.
TextRange	surroundElements(Project project, Editor editor, PsiElement [] elements) Performs the Surround With action on the specified range of elements.
TextRange	surroundStatements(Project project, Editor editor, PsiElement container, PsiElement[] statements)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaWithDoWhileSurrounder

public JavaWithDoWhileSurrounder()

Method Detail

getTemplateDescription

public java.lang.String getTemplateDescription()

Description copied from interface: Surrounder

Returns the user-visible name of the Surround With template.

Returns:

the template name

surroundStatements

public TextRange surroundStatements(Project project,
                                    Editor editor,
                                    PsiElement container,
                                    PsiElement[] statements)
                             throws IncorrectOperationException

Throws:

IncorrectOperationException

isApplicable

public boolean isApplicable(PsiElement [] elements)

Description copied from interface: Surrounder

Checks if the template can be used to surround the specified range of elements.

Specified by:

isApplicable in interface Surrounder

Parameters:

elements - the elements to be surrounded

Returns:

true if the template is applicable to the elements, false otherwise.

surroundElements

public TextRange surroundElements(Project project,
                                  Editor editor,
                                  PsiElement [] elements)
                           throws IncorrectOperationException

Description copied from interface: Surrounder

Performs the Surround With action on the specified range of elements.

Specified by:

surroundElements in interface Surrounder

Parameters:

project - the project containing the elements.

editor - the editor in which the action is invoked.

elements - the elements to be surrounded.

Returns:

range to select/to position the caret

Throws:

IncorrectOperationException

addAfter

protected PsiStatement addAfter(PsiStatement statement,
                                PsiElement container,
                                PsiElement[] statements)

addRangeWithinContainer

protected static void addRangeWithinContainer(PsiCodeBlock codeBlock,
                                              PsiElement container,
                                              PsiElement[] statements,
                                              boolean canBreak)

addCodeBlockContents

protected static void addCodeBlockContents(PsiCodeBlock codeBlock,
                                           PsiBlockStatement statement)