Package io.github.wasabithumb.jtoml.comment

Enum Class CommentPosition

java.lang.Object

java.lang.Enum<CommentPosition>

io.github.wasabithumb.jtoml.comment.CommentPosition

All Implemented Interfaces:

Serializable, Comparable<CommentPosition>, Constable

@AvailableSince("0.6.0")
public enum CommentPosition
extends Enum<CommentPosition>

Represents the part of a TOML expression which a comment is bound to. One of PRE, POST pr INLINE.

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
INLINE	Comment is placed on the same line as the target expression.
POST	Comment is bound to the line(s) directly after the target expression.
PRE	Comment is bound to the line(s) directly before the target expression.

Method Summary

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

PRE

public static final CommentPosition PRE

Comment is bound to the line(s) directly before the target expression.

INLINE

public static final CommentPosition INLINE

Comment is placed on the same line as the target expression.

POST

public static final CommentPosition POST

Comment is bound to the line(s) directly after the target expression.

Method Details

values

public static CommentPosition[] 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 CommentPosition 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