dev.dejvokep.boostedyaml.block

Enum Comments.Position

java.lang.Object

java.lang.Enum<Comments.Position>

dev.dejvokep.boostedyaml.block.Comments.Position

All Implemented Interfaces:

Serializable, Comparable<Comments.Position>

Enclosing class:

Comments

public static enum Comments.Position
extends Enum<Comments.Position>

Comment position relative to the node (scalar; see Comments.NodeType) to which the comment is attached.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Puts the comments after the node.
BEFORE Puts the comments before the node.
INLINE Puts the comments inline with the node.

Method Summary

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

BEFORE

public static final Comments.Position BEFORE

Puts the comments before the node.

INLINE

public static final Comments.Position INLINE

Puts the comments inline with the node.

Please note this method may de-align comments to other nodes when reloaded; errors might be thrown in some cases. It is advised to never use this position.

AFTER

public static final Comments.Position AFTER

Puts the comments after the node.

Please note this method may de-align comments to other nodes when reloaded; errors might be thrown in some cases. It is advised to never use this position.

Method Detail

values

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

Returns:

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

valueOf

public static Comments.Position valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null