Package net.elytrium.serializer.annotations

Enum Class Comment.At

java.lang.Object

java.lang.Enum<Comment.At>

net.elytrium.serializer.annotations.Comment.At

All Implemented Interfaces:

Serializable, Comparable<Comment.At>, Constable

Enclosing class:

Comment

public static enum Comment.At
extends Enum<Comment.At>

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
APPEND	The comment will be placed after the field.
PREPEND	The comment will be placed before the field.
SAME_LINE	The comment will be placed on the same line with the field.

Method Summary

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

PREPEND

public static final Comment.At PREPEND

The comment will be placed before the field.

 
   # Line1
   # Line2
   regular-field: "regular value"
  

SAME_LINE

public static final Comment.At SAME_LINE

The comment will be placed on the same line with the field.

The comment text shouldn't have more than one line.

 
   regular-field: "regular value" # Line1 # Line2
  

APPEND

public static final Comment.At APPEND

The comment will be placed after the field.

 
   regular-field: "regular value"
   # Line1
   # Line2
  

Method Details

values

public static Comment.At[] 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 Comment.At 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