Package com.palantir.javaformat

Enum Class LastLevelBreakability

java.lang.Object

java.lang.Enum<LastLevelBreakability>

com.palantir.javaformat.LastLevelBreakability

All Implemented Interfaces:

Serializable, Comparable<LastLevelBreakability>, Constable

public enum LastLevelBreakability
extends Enum<LastLevelBreakability>

How to decide whether to break the last inner level ("this level") of a parent level with BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORT	Default behaviour.
ACCEPT_INLINE_CHAIN	Unconditionally allow ending an inline chain at this level, after which this level may be broken as usual, or a prefix thereof could be inlined further (if it has the appropriate break behaviour of BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean)).
ACCEPT_INLINE_CHAIN_IF_SIMPLE_OTHERWISE_CHECK_INNER	Behaves like ACCEPT_INLINE_CHAIN if the current inlined levels are all simple (according to OpenOp.complexity()), otherwise behave like CHECK_INNER.
CHECK_INNER	Delegate to the LastLevelBreakability of _this_ level's last inner level.

Method Summary

Modifier and Type	Method	Description
static LastLevelBreakability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LastLevelBreakability[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ABORT

public static final LastLevelBreakability ABORT

Default behaviour. When processing a BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean) chain, if we've arrived at a level with this breakability, then we should abort the chain.

ACCEPT_INLINE_CHAIN

public static final LastLevelBreakability ACCEPT_INLINE_CHAIN

Unconditionally allow ending an inline chain at this level, after which this level may be broken as usual, or a prefix thereof could be inlined further (if it has the appropriate break behaviour of BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean)). This should only be used when you know that the first non-Level Doc inside this level, if you flatten it, is a Break.

CHECK_INNER

public static final LastLevelBreakability CHECK_INNER

Delegate to the LastLevelBreakability of _this_ level's last inner level. Typically, this will be true if this level is not immediately followed by a break (see StartsWithBreakVisitor). Behaves the same as ABORT if this level is not BreakBehaviour.Cases.preferBreakingLastInnerLevel(boolean).

ACCEPT_INLINE_CHAIN_IF_SIMPLE_OTHERWISE_CHECK_INNER

public static final LastLevelBreakability ACCEPT_INLINE_CHAIN_IF_SIMPLE_OTHERWISE_CHECK_INNER

Behaves like ACCEPT_INLINE_CHAIN if the current inlined levels are all simple (according to OpenOp.complexity()), otherwise behave like CHECK_INNER.

Method Details

values

public static LastLevelBreakability[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LastLevelBreakability valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null