Enum TypeConvention
- java.lang.Object
-
- java.lang.Enum<TypeConvention>
-
- io.micronaut.core.naming.conventions.TypeConvention
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TypeConvention>
public enum TypeConvention extends java.lang.Enum<TypeConvention>
Common conventions for types
.- Since:
- 1.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONTROLLER
FACTORY
JOB
REPOSITORY
SERVICE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
asHyphenatedName(java.lang.Class type)
Returns the hyphenated equivalent for this convention for the given class.java.lang.String
asPropertyName(java.lang.Class type)
Returns the property name equivalent for this convention for the given class.static TypeConvention
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TypeConvention[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static TypeConvention[] 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 (TypeConvention c : TypeConvention.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TypeConvention 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 namejava.lang.NullPointerException
- if the argument is null
-
asPropertyName
public java.lang.String asPropertyName(java.lang.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 java.lang.String asHyphenatedName(java.lang.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
-
-