com.palantir.javaformat

Enum PartialInlineability

java.lang.Object

java.lang.Enum<PartialInlineability>

com.palantir.javaformat.PartialInlineability

All Implemented Interfaces:

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

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

What are the conditions for a level to be partially inlineable. Partial inlining refers to the behaviour of BreakBehaviours.breakOnlyIfInnerLevelsThenFitOnOneLine(boolean) where a level is too large to fit on the current line, but a prefix thereof is partially inlined onto the current line.

Specifically, when inlining a level with the above behaviour, the partial inlineability of its first child level (and that level's first child, recursively) is queried in order to determine if we need to ensure there's enough room for some additional prefix of that level.

The reason for this is to prevent degenerate formattings like

 Object foo = someSuperLongMethod(some |
         .fully                        |
         .qualified                    |
         .ClassName                    |
         .doSomething());              |
 

and instead prefer breaking earlier to keep the prefix on the same line, like:

 Object foo = someSuperLongMethod(     |
         some.fully.qualified.ClassName|
                 .doSomething());      |
 

Note that this works as a mandatory access control. Namely, if it's allowed to partially inline a level, what are the additional conditions that have to be met in order for the inlining to go ahead.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_PARTIALLY_INLINEABLE The level may always be partially inlined, regardless of how much space is left on the current line.
IF_FIRST_LEVEL_FITS Partially inlineable if the first inner level of this level fits on the current line.

Method Summary

Modifier and Type	Method and Description
static PartialInlineability	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PartialInlineability[]	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_PARTIALLY_INLINEABLE

public static final PartialInlineability ALWAYS_PARTIALLY_INLINEABLE

The level may always be partially inlined, regardless of how much space is left on the current line.

This is usually only appropriate for levels that start with a direct Break, as opposed to a Break that's nested inside some other levels.

IF_FIRST_LEVEL_FITS

public static final PartialInlineability IF_FIRST_LEVEL_FITS

Partially inlineable if the first inner level of this level fits on the current line.

This assumes that the next Doc after that starts with a Break (see StartsWithBreakVisitor) and makes sense in contexts like JavaInputAstVisitor.visitDotWithPrefix(java.util.List<org.openjdk.source.tree.ExpressionTree>, boolean, java.util.Collection<java.lang.Integer>, com.palantir.javaformat.doc.FillMode) where we want to treat first doc (the longest prefix) as a single entity to be fit onto the same line.

Method Detail

values

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

Returns:

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

valueOf

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