Package com.intellij.formatting

Class SpacingBuilder

java.lang.Object

com.intellij.formatting.SpacingBuilder

public class SpacingBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpacingBuilder.RuleBuilder

Constructor Summary

Constructors

Constructor and Description
SpacingBuilder(CodeStyleSettings codeStyleSettings) Deprecated. Use SpacingBuilder(CodeStyleSettings, Language) or SpacingBuilder(CommonCodeStyleSettings) instead
SpacingBuilder(CodeStyleSettings codeStyleSettings, Language language) Creates SpacingBuilder with given code style settings and language whose settings must be used.
SpacingBuilder(CommonCodeStyleSettings languageCodeStyleSettings) Creates SpacingBuilder with given language code style settings.

Method Summary

Modifier and Type	Method and Description
SpacingBuilder.RuleBuilder	after(IElementType elementType)
SpacingBuilder.RuleBuilder	after(TokenSet tokenSet)
SpacingBuilder.RuleBuilder	afterInside(IElementType elementType, IElementType parentType)
SpacingBuilder.RuleBuilder	afterInside(IElementType elementType, TokenSet parentType)
SpacingBuilder.RuleBuilder	afterInside(TokenSet tokenSet, IElementType parentType)
SpacingBuilder	append(SpacingBuilder builder)
SpacingBuilder.RuleBuilder	around(IElementType elementType)
SpacingBuilder.RuleBuilder	around(TokenSet tokenSet)
SpacingBuilder.RuleBuilder	aroundInside(IElementType token, IElementType parent)
SpacingBuilder.RuleBuilder	aroundInside(IElementType token, TokenSet parent)
SpacingBuilder.RuleBuilder	aroundInside(TokenSet tokenSet, IElementType parent)
SpacingBuilder.RuleBuilder	aroundInside(TokenSet tokenSet, TokenSet parent)
SpacingBuilder.RuleBuilder	before(IElementType elementType)
SpacingBuilder.RuleBuilder	before(TokenSet tokenSet)
SpacingBuilder.RuleBuilder	beforeInside(IElementType elementType, IElementType parentType)
SpacingBuilder.RuleBuilder	beforeInside(IElementType elementType, TokenSet parentTypes)
SpacingBuilder.RuleBuilder	beforeInside(TokenSet tokenSet, IElementType parentType)
SpacingBuilder.RuleBuilder	between(IElementType left, IElementType right)
SpacingBuilder.RuleBuilder	between(IElementType left, TokenSet rightSet)
SpacingBuilder.RuleBuilder	between(TokenSet leftSet, IElementType right)
SpacingBuilder.RuleBuilder	between(TokenSet leftType, TokenSet rightType)
SpacingBuilder.RuleBuilder	betweenInside(IElementType leftType, IElementType rightType, IElementType parentType)
SpacingBuilder.RuleBuilder	betweenInside(TokenSet leftSet, TokenSet rightSet, IElementType parentType)
Spacing	getSpacing(Block parent, Block child1, Block child2) Works only with instances of ASTBlock, in other case returns null.
Spacing	getSpacing(Block parentBlock, IElementType parentType, IElementType child1Type, IElementType child2Type)
SpacingBuilder.RuleBuilder	withinPair(IElementType pairFirst, IElementType pairSecond)
SpacingBuilder.RuleBuilder	withinPairInside(IElementType pairFirst, IElementType pairSecond, IElementType parent)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpacingBuilder

@Deprecated
public SpacingBuilder(CodeStyleSettings codeStyleSettings)

Deprecated. Use SpacingBuilder(CodeStyleSettings, Language) or SpacingBuilder(CommonCodeStyleSettings) instead

Parameters:

codeStyleSettings -

SpacingBuilder

public SpacingBuilder(CodeStyleSettings codeStyleSettings,
                      Language language)

Creates SpacingBuilder with given code style settings and language whose settings must be used.

Parameters:

codeStyleSettings - The root code style settings.

language - The language to obtain settings for.

SpacingBuilder

public SpacingBuilder(CommonCodeStyleSettings languageCodeStyleSettings)

Creates SpacingBuilder with given language code style settings.

Parameters:

languageCodeStyleSettings - The language code style settings. Note that getLanguage() method must not return null!

Method Detail

after

public SpacingBuilder.RuleBuilder after(IElementType elementType)

after

public SpacingBuilder.RuleBuilder after(TokenSet tokenSet)

afterInside

public SpacingBuilder.RuleBuilder afterInside(IElementType elementType,
                                              IElementType parentType)

afterInside

public SpacingBuilder.RuleBuilder afterInside(IElementType elementType,
                                              TokenSet parentType)

afterInside

public SpacingBuilder.RuleBuilder afterInside(TokenSet tokenSet,
                                              IElementType parentType)

before

public SpacingBuilder.RuleBuilder before(IElementType elementType)

before

public SpacingBuilder.RuleBuilder before(TokenSet tokenSet)

beforeInside

public SpacingBuilder.RuleBuilder beforeInside(TokenSet tokenSet,
                                               IElementType parentType)

beforeInside

public SpacingBuilder.RuleBuilder beforeInside(IElementType elementType,
                                               IElementType parentType)

beforeInside

public SpacingBuilder.RuleBuilder beforeInside(IElementType elementType,
                                               TokenSet parentTypes)

between

public SpacingBuilder.RuleBuilder between(IElementType left,
                                          IElementType right)

between

public SpacingBuilder.RuleBuilder between(IElementType left,
                                          TokenSet rightSet)

between

public SpacingBuilder.RuleBuilder between(TokenSet leftSet,
                                          IElementType right)

between

public SpacingBuilder.RuleBuilder between(TokenSet leftType,
                                          TokenSet rightType)

betweenInside

public SpacingBuilder.RuleBuilder betweenInside(IElementType leftType,
                                                IElementType rightType,
                                                IElementType parentType)

betweenInside

public SpacingBuilder.RuleBuilder betweenInside(TokenSet leftSet,
                                                TokenSet rightSet,
                                                IElementType parentType)

withinPair

public SpacingBuilder.RuleBuilder withinPair(IElementType pairFirst,
                                             IElementType pairSecond)

withinPairInside

public SpacingBuilder.RuleBuilder withinPairInside(IElementType pairFirst,
                                                   IElementType pairSecond,
                                                   IElementType parent)

around

public SpacingBuilder.RuleBuilder around(IElementType elementType)

around

public SpacingBuilder.RuleBuilder around(TokenSet tokenSet)

aroundInside

public SpacingBuilder.RuleBuilder aroundInside(TokenSet tokenSet,
                                               TokenSet parent)

aroundInside

public SpacingBuilder.RuleBuilder aroundInside(TokenSet tokenSet,
                                               IElementType parent)

aroundInside

public SpacingBuilder.RuleBuilder aroundInside(IElementType token,
                                               IElementType parent)

aroundInside

public SpacingBuilder.RuleBuilder aroundInside(IElementType token,
                                               TokenSet parent)

append

public SpacingBuilder append(SpacingBuilder builder)

getSpacing

public Spacing getSpacing(Block parentBlock,
                          IElementType parentType,
                          IElementType child1Type,
                          IElementType child2Type)

See Also:

getSpacing(Block, Block, Block)

getSpacing

public Spacing getSpacing(Block parent,
                          Block child1,
                          Block child2)

Works only with instances of ASTBlock, in other case returns null.

Parameters:

parent - expected an instance of ASTBlock.

child1 - expected an instance of ASTBlock.

child2 - expected an instance of ASTBlock.

See Also:

getSpacing(Block, IElementType, IElementType, IElementType)