Package com.intellij.formatting.alignment

Class AlignmentInColumnsHelper

java.lang.Object

com.intellij.formatting.alignment.AlignmentInColumnsHelper

public class AlignmentInColumnsHelper
extends java.lang.Object

This class provides helper methods to use for 'align in columns' processing.

'Align in columns' here means format the code like below:

     class Test {
         private int    iii = 1;
         private double d   = 2;
     }
 

I.e. components of two lines are aligned to each other in columns.

This class is not singleton but it's thread-safe and provides single-point-of-usage field INSTANCE.

Thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static AlignmentInColumnsHelper	INSTANCE Single-point-of-usage field.

Constructor Summary

Constructors

Constructor and Description
AlignmentInColumnsHelper()

Method Summary

Modifier and Type	Method and Description
boolean	useDifferentVarDeclarationAlignment(ASTNode node, AlignmentInColumnsConfig config, int blankLinesToBeKeptOnReformat) Allows to answer if given node should be aligned to the previous node of the same type according to the given alignment config assuming that given node is a variable declaration.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final AlignmentInColumnsHelper INSTANCE

Single-point-of-usage field.

Constructor Detail

AlignmentInColumnsHelper

public AlignmentInColumnsHelper()

Method Detail

useDifferentVarDeclarationAlignment

public boolean useDifferentVarDeclarationAlignment(ASTNode node,
                                                   AlignmentInColumnsConfig config,
                                                   int blankLinesToBeKeptOnReformat)

Allows to answer if given node should be aligned to the previous node of the same type according to the given alignment config assuming that given node is a variable declaration.

Parameters:

node - target node which alignment strategy is to be defined

config - alignment config to use for processing

blankLinesToBeKeptOnReformat - corresponding KEEP_LINE_IN_* formatting setting

Returns:

true if given node should be aligned to the previous one; false otherwise