Package com.intellij.psi.formatter.java

Class AbstractJavaBlock

java.lang.Object

com.intellij.psi.formatter.common.AbstractBlock

com.intellij.psi.formatter.java.AbstractJavaBlock

All Implemented Interfaces:

ASTBlock, Block, ExtraRangesProvider, JavaBlock, ReservedWrapsProvider

Direct Known Subclasses:

BlockContainingJavaBlock, CodeBlockBlock, CommentWithInjectionBlock, DocCommentBlock, ExtendsListBlock, LabeledJavaBlock, SimpleJavaBlock, TextBlockBlock

public abstract class AbstractJavaBlock
extends AbstractBlock
implements JavaBlock, ReservedWrapsProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected AlignmentStrategy	myAlignmentStrategy
protected Alignment	myChildAlignment
protected Indent	myChildIndent
protected CommonCodeStyleSettings.IndentOptions	myIndentSettings
protected JavaCodeStyleSettings	myJavaSettings
protected Alignment	myReservedAlignment
protected Alignment	myReservedAlignment2
protected CommonCodeStyleSettings	mySettings
protected boolean	myUseChildAttributes

Fields inherited from class com.intellij.psi.formatter.common.AbstractBlock

EMPTY, myAlignment, myNode, myWrap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJavaBlock(ASTNode node, Wrap wrap, Alignment alignment, Indent indent, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, FormattingMode formattingMode)
protected	AbstractJavaBlock(ASTNode node, Wrap wrap, AlignmentStrategy alignmentStrategy, Indent indent, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, FormattingMode formattingMode)
protected	AbstractJavaBlock(ASTNode node, Wrap wrap, Indent indent, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, JavaWrapManager wrapManager, AlignmentStrategy alignmentStrategy, FormattingMode formattingMode)

Method Summary

Modifier and Type	Method and Description
protected Wrap	arrangeChildWrap(ASTNode child, Wrap defaultWrap)
protected Alignment	chooseAlignment(Alignment alignment, Alignment alignment2, ASTNode child)
protected ASTNode	composeCodeBlock(java.util.List<? super Block> result, ASTNode child, Indent indent, int childrenIndent, Wrap childWrap)
static Alignment	createAlignment(Alignment base, boolean alignOption, Alignment defaultAlignment)
static Alignment	createAlignment(boolean alignOption, Alignment defaultAlignment)
protected Alignment	createChildAlignment()
protected Wrap	createChildWrap()
SyntheticCodeBlock	createCodeBlockBlock(java.util.List<Block> localResult, Indent indent, int childrenIndent)
Block	createJavaBlock(ASTNode child, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, Indent indent, Wrap wrap, Alignment alignment, FormattingMode formattingMode)
Block	createJavaBlock(ASTNode child, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, Indent indent, Wrap wrap, AlignmentStrategy alignmentStrategy, FormattingMode formattingMode)
protected static Indent	createNormalIndent()
protected static Indent	createNormalIndent(int baseChildrenIndent)
ChildAttributes	getChildAttributes(int newChildIndex) Returns the alignment and indent attributes which are applied to a new block inserted at the specified position in the list of children of this block.
protected Indent	getChildIndent()
protected Indent	getCodeBlockChildExternalIndent(int newChildIndex)
protected Indent	getCodeBlockExternalIndent()
protected Indent	getCodeBlockInternalIndent(int baseChildrenIndent)
ASTNode	getFirstTreeNode()
protected FormattingMode	getFormattingMode()
Indent	getIndent() Returns an indent object indicating how this block is indented relative to its parent block.
AbstractJavaBlock	getParentBlock()
Wrap	getReservedWrap(IElementType elementType) Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored
CommonCodeStyleSettings	getSettings()
Spacing	getSpacing(Block child1, Block child2) Returns a spacing object indicating what spaces and/or line breaks are added between two specified children of this block.
protected ChildAlignmentStrategyProvider	getStrategyProvider()
protected static ASTNode	getTreeNode(Block block)
protected Alignment	getUsedAlignment(int newChildIndex)
protected boolean	isAfter(int newChildIndex, IElementType [] elementTypes)
boolean	isLeaf() Returns true if the specified block may not contain child blocks.
protected static boolean	isRBrace(ASTNode child)
protected static boolean	isStatement(ASTNode child, ASTNode parentNode)
static Block	newJavaBlock(ASTNode child, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, FormattingMode formattingMode)
static Block	newJavaBlock(ASTNode child, CommonCodeStyleSettings settings, JavaCodeStyleSettings javaSettings, Indent indent, Wrap wrap, AlignmentStrategy strategy, FormattingMode formattingMode)
protected ASTNode	processChild(java.util.List<Block> result, ASTNode child, AlignmentStrategy alignmentStrategy, Wrap defaultWrap, Indent childIndent)
protected ASTNode	processChild(java.util.List<Block> result, ASTNode child, AlignmentStrategy alignmentStrategy, Wrap defaultWrap, Indent childIndent, int childOffset)
protected ASTNode	processChild(java.util.List<Block> result, ASTNode child, Alignment defaultAlignment, Wrap defaultWrap, Indent childIndent)
void	setParentBlock(AbstractJavaBlock parentBlock)
void	setReservedWrap(Wrap reservedWrap, IElementType operationType) Defines contract for associating operation type and particular wrap instance.

Methods inherited from class com.intellij.psi.formatter.common.AbstractBlock

buildChildren, getAlignment, getExtraRangesToFormat, getNode, getSubBlocks, getTextRange, getWrap, isBuildIndentsOnly, isIncomplete, setBuildIndentsOnly, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.formatting.ASTBlock

getElementType, getNode, getPsiElement

Methods inherited from interface com.intellij.formatting.Block

getDebugName

Field Detail

mySettings

protected final CommonCodeStyleSettings mySettings

myJavaSettings

protected final JavaCodeStyleSettings myJavaSettings

myIndentSettings

protected final CommonCodeStyleSettings.IndentOptions myIndentSettings

myChildIndent

protected Indent myChildIndent

myChildAlignment

protected Alignment myChildAlignment

myUseChildAttributes

protected boolean myUseChildAttributes

myAlignmentStrategy

protected final AlignmentStrategy myAlignmentStrategy

myReservedAlignment

protected Alignment myReservedAlignment

myReservedAlignment2

protected Alignment myReservedAlignment2

Constructor Detail

AbstractJavaBlock

protected AbstractJavaBlock(ASTNode node,
                            Wrap wrap,
                            Alignment alignment,
                            Indent indent,
                            CommonCodeStyleSettings settings,
                            JavaCodeStyleSettings javaSettings,
                            FormattingMode formattingMode)

AbstractJavaBlock

protected AbstractJavaBlock(ASTNode node,
                            Wrap wrap,
                            AlignmentStrategy alignmentStrategy,
                            Indent indent,
                            CommonCodeStyleSettings settings,
                            JavaCodeStyleSettings javaSettings,
                            FormattingMode formattingMode)

AbstractJavaBlock

protected AbstractJavaBlock(ASTNode node,
                            Wrap wrap,
                            Indent indent,
                            CommonCodeStyleSettings settings,
                            JavaCodeStyleSettings javaSettings,
                            JavaWrapManager wrapManager,
                            AlignmentStrategy alignmentStrategy,
                            FormattingMode formattingMode)

Method Detail

createJavaBlock

public Block createJavaBlock(ASTNode child,
                             CommonCodeStyleSettings settings,
                             JavaCodeStyleSettings javaSettings,
                             Indent indent,
                             Wrap wrap,
                             Alignment alignment,
                             FormattingMode formattingMode)

createJavaBlock

public Block createJavaBlock(ASTNode child,
                             CommonCodeStyleSettings settings,
                             JavaCodeStyleSettings javaSettings,
                             Indent indent,
                             Wrap wrap,
                             AlignmentStrategy alignmentStrategy,
                             FormattingMode formattingMode)

newJavaBlock

public static Block newJavaBlock(ASTNode child,
                                 CommonCodeStyleSettings settings,
                                 JavaCodeStyleSettings javaSettings,
                                 FormattingMode formattingMode)

newJavaBlock

public static Block newJavaBlock(ASTNode child,
                                 CommonCodeStyleSettings settings,
                                 JavaCodeStyleSettings javaSettings,
                                 Indent indent,
                                 Wrap wrap,
                                 AlignmentStrategy strategy,
                                 FormattingMode formattingMode)

isRBrace

protected static boolean isRBrace(ASTNode child)

getSpacing

public Spacing getSpacing(Block child1,
                          Block child2)

Description copied from interface: Block

Returns a spacing object indicating what spaces and/or line breaks are added between two specified children of this block.

Specified by:

getSpacing in interface Block

Parameters:

child1 - the first child for which spacing is requested; null if given 'child2' block is the first document block

child2 - the second child for which spacing is requested.

Returns:

the spacing instance, or null if no special spacing is required. If null is returned, the formatter does not insert or delete spaces between the child blocks, but may insert a line break if the line wraps at the position between the child blocks.

See Also:

Spacing.createSpacing(int, int, int, boolean, int), Spacing.getReadOnlySpacing()

getFirstTreeNode

public ASTNode getFirstTreeNode()

Specified by:

getFirstTreeNode in interface JavaBlock

getIndent

public Indent getIndent()

Description copied from interface: Block

Returns an indent object indicating how this block is indented relative to its parent block.

Specified by:

getIndent in interface Block

Overrides:

getIndent in class AbstractBlock

Returns:

the indent object, or null if the default indent ("continuation without first") should be used.

See Also:

Indent.getContinuationWithoutFirstIndent()

isStatement

protected static boolean isStatement(ASTNode child,
                                     ASTNode parentNode)

createChildWrap

protected Wrap createChildWrap()

createChildAlignment

protected Alignment createChildAlignment()

chooseAlignment

protected Alignment chooseAlignment(Alignment alignment,
                                    Alignment alignment2,
                                    ASTNode child)

processChild

protected ASTNode processChild(java.util.List<Block> result,
                               ASTNode child,
                               Alignment defaultAlignment,
                               Wrap defaultWrap,
                               Indent childIndent)

processChild

protected ASTNode processChild(java.util.List<Block> result,
                               ASTNode child,
                               AlignmentStrategy alignmentStrategy,
                               Wrap defaultWrap,
                               Indent childIndent)

processChild

protected ASTNode processChild(java.util.List<Block> result,
                               ASTNode child,
                               AlignmentStrategy alignmentStrategy,
                               Wrap defaultWrap,
                               Indent childIndent,
                               int childOffset)

createAlignment

public static Alignment createAlignment(boolean alignOption,
                                        Alignment defaultAlignment)

createAlignment

public static Alignment createAlignment(Alignment base,
                                        boolean alignOption,
                                        Alignment defaultAlignment)

arrangeChildWrap

protected Wrap arrangeChildWrap(ASTNode child,
                                Wrap defaultWrap)

getCodeBlockInternalIndent

protected Indent getCodeBlockInternalIndent(int baseChildrenIndent)

createNormalIndent

protected static Indent createNormalIndent()

createNormalIndent

protected static Indent createNormalIndent(int baseChildrenIndent)

getCodeBlockExternalIndent

protected Indent getCodeBlockExternalIndent()

getCodeBlockChildExternalIndent

protected Indent getCodeBlockChildExternalIndent(int newChildIndex)

getReservedWrap

public Wrap getReservedWrap(IElementType elementType)

Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored

Specified by:

getReservedWrap in interface ReservedWrapsProvider

Parameters:

elementType - target element type

Returns:

null all the time

setReservedWrap

public void setReservedWrap(Wrap reservedWrap,
                            IElementType operationType)

Defines contract for associating operation type and particular wrap instance. I.e. given wrap object may be returned from subsequent getReservedWrap(IElementType) call if given operation type is used as an argument there.

Default implementation (setReservedWrap(Wrap, IElementType)) does nothing.

Note: this method is considered to be a legacy heritage and is assumed to be removed as soon as formatting processing is refactored

Parameters:

reservedWrap - reserved wrap instance

operationType - target operation type to associate with the given wrap instance

getTreeNode

protected static ASTNode getTreeNode(Block block)

getChildAttributes

public ChildAttributes getChildAttributes(int newChildIndex)

Description copied from interface: Block

Returns the alignment and indent attributes which are applied to a new block inserted at the specified position in the list of children of this block. Used for performing automatic indent when Enter is pressed.

Specified by:

getChildAttributes in interface Block

Overrides:

getChildAttributes in class AbstractBlock

Parameters:

newChildIndex - the index where a new child is inserted.

Returns:

the object containing the indent and alignment settings for the new child.

getChildIndent

protected Indent getChildIndent()

Overrides:

getChildIndent in class AbstractBlock

getSettings

public CommonCodeStyleSettings getSettings()

isAfter

protected boolean isAfter(int newChildIndex,
                          IElementType [] elementTypes)

getUsedAlignment

protected Alignment getUsedAlignment(int newChildIndex)

isLeaf

public boolean isLeaf()

Description copied from interface: Block

Returns true if the specified block may not contain child blocks. Used as an optimization to avoid building the complete formatting model through calls to Block.getSubBlocks().

Specified by:

isLeaf in interface Block

Returns:

true if the block is a leaf block and may not contain child blocks, false otherwise.

composeCodeBlock

protected ASTNode composeCodeBlock(java.util.List<? super Block> result,
                                   ASTNode child,
                                   Indent indent,
                                   int childrenIndent,
                                   Wrap childWrap)

getStrategyProvider

protected ChildAlignmentStrategyProvider getStrategyProvider()

getParentBlock

public AbstractJavaBlock getParentBlock()

setParentBlock

public void setParentBlock(AbstractJavaBlock parentBlock)

createCodeBlockBlock

public SyntheticCodeBlock createCodeBlockBlock(java.util.List<Block> localResult,
                                               Indent indent,
                                               int childrenIndent)

getFormattingMode

protected FormattingMode getFormattingMode()