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 key/value node.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Puts the comments after the key/value node.
BEFORE Puts the comments before the key/value node.
INLINE Puts the comments inline with the key/value 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 key/value node.

Serialization:

• FlowStyle.BLOCK: always serialized
• FlowStyle.FLOW: serialized only with the root section

An attempt to dump a document with comments set at this position will cause them to permanently be lost.

Compatibility:

CommentType.IN_LINE is not allowed to be used at this position. You can use Comments.create(String, Position) to create comments with guaranteed compatibility.

INLINE

public static final Comments.Position INLINE

Puts the comments inline with the key/value node.

Serialization:

• FlowStyle.BLOCK: serialized only with keys and values that are represented as a scalar (not a map, section, or an array-like object)
• FlowStyle.FLOW: serialized only with keys and values that are represented as a map, section or an array-like object

An attempt to dump a document with comments set at this position will cause them to permanently be lost.

Compatibility:

CommentType.IN_LINE is the only comment type allowed at this position. You can use Comments.create(String, Position) to create comments with guaranteed compatibility.

AFTER

public static final Comments.Position AFTER

Puts the comments after the key/value node.

Serialization:

• FlowStyle.BLOCK: always serialized
• FlowStyle.FLOW: serialized only with the root section

If there is any following block in the document, comments at this position might be de-aligned and loaded as BEFORE comments for that block. An attempt to dump a document with comments set at this position will cause them to permanently be lost.

Compatibility:

CommentType.IN_LINE is the only comment type allowed at this position. You can use Comments.create(String, Position) to create comments with guaranteed compatibility.

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