org.seasar.doma.jdbc.entity

Enum NamingType

java.lang.Object

java.lang.Enum<NamingType>

org.seasar.doma.jdbc.entity.NamingType

All Implemented Interfaces:

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

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

A naming convention.

This convention resolves the table name from the entity name when Table.name() is not specified at the entity class, and also resolves the column name from the entity property name when Column.name() is not specified at the property field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LENIENT_SNAKE_LOWER_CASE Deprecated.
LENIENT_SNAKE_UPPER_CASE Deprecated.
LOWER_CASE Converts the camel case text to the lower case text.
NONE Converts nothing.
SNAKE_LOWER_CASE Converts the camel case text to the text that is snake case and lower case.
SNAKE_UPPER_CASE Converts the camel case text to the text that is snake case and upper case.
UPPER_CASE Converts the camel case text to the upper case text.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	apply(java.lang.String text) Applies this convention.
abstract java.lang.String	revert(java.lang.String text) Reverts the text to the original as much as possible.
static NamingType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NamingType[]	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

NONE

public static final NamingType NONE

Converts nothing.

SNAKE_UPPER_CASE

public static final NamingType SNAKE_UPPER_CASE

Converts the camel case text to the text that is snake case and upper case.

For examples:

• aaaBbb is converted to AAA_BBB.
• aaa3Bbb is converted to AAA3_BBB.

SNAKE_LOWER_CASE

public static final NamingType SNAKE_LOWER_CASE

Converts the camel case text to the text that is snake case and lower case.

For examples:

• aaaBbb is converted to aaa_bbb.
• aaa3Bbb is converted to aaa3_bbb.

LENIENT_SNAKE_UPPER_CASE

@Deprecated
public static final NamingType LENIENT_SNAKE_UPPER_CASE

Deprecated.

LENIENT_SNAKE_LOWER_CASE

@Deprecated
public static final NamingType LENIENT_SNAKE_LOWER_CASE

Deprecated.

UPPER_CASE

public static final NamingType UPPER_CASE

Converts the camel case text to the upper case text.

For examples:

• aaaBbb is converted to AAABBB.

LOWER_CASE

public static final NamingType LOWER_CASE

Converts the camel case text to the lower case text.

For examples:

• aaaBbb is converted to aaabbb.

Method Detail

values

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

Returns:

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

valueOf

public static NamingType 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

apply

public abstract java.lang.String apply(java.lang.String text)

Applies this convention.

Parameters:

text - the entity name or the property name

Returns:

the table name or the column name

revert

public abstract java.lang.String revert(java.lang.String text)

Reverts the text to the original as much as possible.

Parameters:

text - the text that is converted by this convention

Returns:

the original