Package com.intellij.formatting

Enum FormattingStateId

java.lang.Object

java.lang.Enum<FormattingStateId>

com.intellij.formatting.FormattingStateId

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FormattingStateId>

public enum FormattingStateId
extends java.lang.Enum<FormattingStateId>

Enumerates formatting processing states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLYING_CHANGES This element corresponds to formatting phase when all wrapped code blocks are processed and it's time to apply the changes to the underlying document.
EXPANDING_CHILDREN_INDENTS
PROCESSING_BLOCKS This element corresponds to the state when formatter sequentially processes wrapped code blocks and modifies their white spaces according to the current code style settings.
WRAPPING_BLOCKS Corresponds to InitialInfoBuilder.buildFrom(Block, int, CompositeBlockWrapper, WrapImpl, Block).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.util.Set<FormattingStateId>	getPreviousStates()
double	getProgressWeight()
static FormattingStateId	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FormattingStateId[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WRAPPING_BLOCKS

public static final FormattingStateId WRAPPING_BLOCKS

Corresponds to InitialInfoBuilder.buildFrom(Block, int, CompositeBlockWrapper, WrapImpl, Block).

I.e. the first thing formatter does retrieval of all code blocks from target model and wrapping them in order to be able to store information about modified white spaces. That processing may trigger blocks construction because most of our formatting models do that lazily, i.e. they define the root block and build its sub-blocks only on the first request.

PROCESSING_BLOCKS

public static final FormattingStateId PROCESSING_BLOCKS

This element corresponds to the state when formatter sequentially processes wrapped code blocks and modifies their white spaces according to the current code style settings.

EXPANDING_CHILDREN_INDENTS

public static final FormattingStateId EXPANDING_CHILDREN_INDENTS

APPLYING_CHANGES

public static final FormattingStateId APPLYING_CHANGES

This element corresponds to formatting phase when all wrapped code blocks are processed and it's time to apply the changes to the underlying document.

Method Detail

values

public static FormattingStateId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FormattingStateId c : FormattingStateId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FormattingStateId valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

Returns:

human-readable textual description of the current state id

getProgressWeight

public double getProgressWeight()

Returns:

'weight' of the current state. Basically, it's assumed that every processing iteration of the state with greater weight is executed longer that processing iteration of the state with the lower weight

getPreviousStates

public java.util.Set<FormattingStateId> getPreviousStates()

Returns:

collection of formatting states that are assumed to be executed prior to the current one