Package org.tomlj

Enum Class TomlComment.Placement

java.lang.Object

java.lang.Enum<TomlComment.Placement>

org.tomlj.TomlComment.Placement

All Implemented Interfaces:

Serializable, Comparable<TomlComment.Placement>, Constable

Enclosing class:

TomlComment

public static enum TomlComment.Placement
extends Enum<TomlComment.Placement>

Where a comment sits relative to the entry it is attached to.

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
ABOVE	A run of comment lines written directly above the entry it is attached to.
AFTER	The comment written on the same line as the entry, after it.
UNATTACHED	A comment attached to no entry: a run that is not directly above one, or a comment on a line with none.

Method Summary

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

ABOVE

public static final TomlComment.Placement ABOVE

A run of comment lines written directly above the entry it is attached to.

AFTER

public static final TomlComment.Placement AFTER

The comment written on the same line as the entry, after it.

UNATTACHED

public static final TomlComment.Placement UNATTACHED

A comment attached to no entry: a run that is not directly above one, or a comment on a line with none. It belongs to the table or array it was written in.

Method Details

values

public static TomlComment.Placement[] 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 TomlComment.Placement 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