Package io.micronaut.core.naming.conventions

Enum Class TypeConvention

java.lang.Object

java.lang.Enum<TypeConvention>

io.micronaut.core.naming.conventions.TypeConvention

All Implemented Interfaces:

Serializable, Comparable<TypeConvention>, Constable

public enum TypeConvention
extends Enum<TypeConvention>

Common conventions for types

.

Since:

1.0

Author:

Graeme Rocher

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
CONTROLLER
FACTORY
JOB
REPOSITORY
SERVICE

Method Summary

Modifier and Type	Method	Description
String	asHyphenatedName(Class type)	Returns the hyphenated equivalent for this convention for the given class.
String	asPropertyName(Class type)	Returns the property name equivalent for this convention for the given class.
static TypeConvention	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TypeConvention[]	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

CONTROLLER

public static final TypeConvention CONTROLLER

SERVICE

public static final TypeConvention SERVICE

REPOSITORY

public static final TypeConvention REPOSITORY

JOB

public static final TypeConvention JOB

FACTORY

public static final TypeConvention FACTORY

Method Details

values

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

asPropertyName

public String asPropertyName(Class type)

Returns the property name equivalent for this convention for the given class. Eg. BookController -> book

Parameters:

type - The type

Returns:

The property name equivalent

asHyphenatedName

public String asHyphenatedName(Class type)

Returns the hyphenated equivalent for this convention for the given class. Eg. BookShopController -> book-shop

Parameters:

type - The type

Returns:

The property name equivalent