Package com.intellij.formatting

Enum WrapType

java.lang.Object

java.lang.Enum<WrapType>

com.intellij.formatting.WrapType

All Implemented Interfaces:

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

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

Defines possible types of a wrap.

See Also:

Wrap.createWrap(WrapType, boolean), Wrap.createChildWrap(Wrap, WrapType, boolean)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS A line break is always inserted before the start of the element.
CHOP_DOWN_IF_LONG A line break is inserted before the start of the element if it is a part of list of elements of the same type and at least one of the elements was wrapped.
NONE A line break is never inserted before the start of the element.
NORMAL A line break is inserted before the start of the element if the right edge of the element goes beyond the specified wrap margin.

Method Summary

Modifier and Type	Method and Description
static WrapType	byLegacyRepresentation(int value) Allows to retrieve wrap type by it's legacy non-type-safe representation (see getLegacyRepresentation()).
int	getLegacyRepresentation() Wrapping types were used as a primitive constants during this enum introduction (e.g.
static WrapType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WrapType[]	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

ALWAYS

public static final WrapType ALWAYS

A line break is always inserted before the start of the element. This corresponds to the "Wrap always" setting in Global Code Style | Wrapping.

NORMAL

public static final WrapType NORMAL

A line break is inserted before the start of the element if the right edge of the element goes beyond the specified wrap margin. This corresponds to the "Wrap if long" setting in Global Code Style | Wrapping.

NONE

public static final WrapType NONE

A line break is never inserted before the start of the element. This corresponds to the "Do not wrap" setting in Global Code Style | Wrapping.

CHOP_DOWN_IF_LONG

public static final WrapType CHOP_DOWN_IF_LONG

A line break is inserted before the start of the element if it is a part of list of elements of the same type and at least one of the elements was wrapped. This corresponds to the "Chop down if long" setting in Global Code Style | Wrapping.

Method Detail

values

public static WrapType[] 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 (WrapType c : WrapType.values())
    System.out.println(c);

Returns:

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

valueOf

public static WrapType 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

byLegacyRepresentation

public static WrapType byLegacyRepresentation(int value)

Allows to retrieve wrap type by it's legacy non-type-safe representation (see getLegacyRepresentation()).

Parameters:

value - legacy representation of the target wrap type

Returns:

wrap type which legacyRepresentation is equal to the given value if any; CHOP_DOWN_IF_LONG otherwise

getLegacyRepresentation

public int getLegacyRepresentation()

Wrapping types were used as a primitive constants during this enum introduction (e.g. CommonCodeStyleSettings.DO_NOT_WRAP etc).

It's possible to map that legacy representation to the object-level enum member via byLegacyRepresentation(int).

Current getter exposes legacy value associated with the current object-level wrap type representation.

Returns:

legacy representation of the current wrap type