io.micronaut.core.naming.conventions

Enum PropertyConvention

java.lang.Object

java.lang.Enum<PropertyConvention>

io.micronaut.core.naming.conventions.PropertyConvention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PropertyConvention>

public enum PropertyConvention
extends java.lang.Enum<PropertyConvention>

Typical conventions used for property names through the system.

Since:

1.0

Author:

Graeme Rocher

Enum Constant Summary

Enum Constants

Enum Constant and Description
ID The ID property used in REST endpoints and object mapping.

Method Summary

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

ID

public static final PropertyConvention ID

The ID property used in REST endpoints and object mapping.

Method Detail

values

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

Returns:

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

valueOf

public static PropertyConvention valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

lowerCaseName

public java.lang.String lowerCaseName()

Returns:

The lowercase name