Package com.diffplug.spotless.kotlin

Enum Class KtfmtStep.TrailingCommaManagementStrategy

java.lang.Object

java.lang.Enum<KtfmtStep.TrailingCommaManagementStrategy>

com.diffplug.spotless.kotlin.KtfmtStep.TrailingCommaManagementStrategy

All Implemented Interfaces:

Serializable, Comparable<KtfmtStep.TrailingCommaManagementStrategy>, Constable

Enclosing class:

KtfmtStep

public static enum KtfmtStep.TrailingCommaManagementStrategy
extends Enum<KtfmtStep.TrailingCommaManagementStrategy>

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
COMPLETE	Fully manage trailing commas, adding and removing them where necessary.
NONE	Do not manage trailing commas at all, only format what is already present.
ONLY_ADD	Only add trailing commas when necessary, but do not remove them.

Method Summary

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

NONE

public static final KtfmtStep.TrailingCommaManagementStrategy NONE

Do not manage trailing commas at all, only format what is already present.

ONLY_ADD

public static final KtfmtStep.TrailingCommaManagementStrategy ONLY_ADD

Only add trailing commas when necessary, but do not remove them.

Lists that cannot fit on one line will have trailing commas inserted. Trailing commas can to be used to "hint" ktfmt that the list should be broken to multiple lines

COMPLETE

public static final KtfmtStep.TrailingCommaManagementStrategy COMPLETE

Fully manage trailing commas, adding and removing them where necessary.

Lists that cannot fit on one line will have trailing commas inserted. Lists that span multiple lines will have them removed. Manually inserted trailing commas cannot be used as a hint to force breaking lists to multiple lines.

Method Details

values

public static KtfmtStep.TrailingCommaManagementStrategy[] 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 KtfmtStep.TrailingCommaManagementStrategy 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