com.palantir.javaformat.doc

Enum FillMode

java.lang.Object

java.lang.Enum<FillMode>

com.palantir.javaformat.doc.FillMode

All Implemented Interfaces:

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

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

Each Break in a Level is either UNIFIED or INDEPENDENT.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCED A FORCED Break will always be broken, and a Level it appears in will not fit on one line.
INDEPENDENT If a Level will not fit on one line, its INDEPENDENT Breaks will be broken independently of each other, to fill in the Level.
UNIFIED If a Level will not fit on one line, all of its UNIFIED Breaks will be broken.

Method Summary

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

UNIFIED

public static final FillMode UNIFIED

If a Level will not fit on one line, all of its UNIFIED Breaks will be broken.

INDEPENDENT

public static final FillMode INDEPENDENT

If a Level will not fit on one line, its INDEPENDENT Breaks will be broken independently of each other, to fill in the Level.

FORCED

public static final FillMode FORCED

A FORCED Break will always be broken, and a Level it appears in will not fit on one line.

Method Detail

values

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

Returns:

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

valueOf

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