com.datastax.oss.driver.api.mapper.entity.naming

Enum NamingConvention

java.lang.Object

java.lang.Enum<NamingConvention>

com.datastax.oss.driver.api.mapper.entity.naming.NamingConvention

All Implemented Interfaces:

Serializable, Comparable<NamingConvention>

public enum NamingConvention
extends Enum<NamingConvention>

A built-in convention to infer CQL column names from the names used in an Entity-annotated class.

See Also:

NamingStrategy

Enum Constant Summary

Enum Constants

Enum Constant and Description
CASE_INSENSITIVE Uses the Java name as-is, as a case-insensitive CQL name, for example Product => Product, productId => productId.
EXACT_CASE Uses the Java name as-is, as a case-sensitive CQL name, for example Product => "Product", productId => "productId".
LOWER_CAMEL_CASE Divide the Java name into words, splitting on upper-case characters; capitalize every word except the first; then concatenate the words and make the result a case-sensitive CQL name, for example Product => "product", productId => "productId".
SNAKE_CASE_INSENSITIVE Divide the Java name into words, splitting on upper-case characters; lower-case everything; then concatenate the words with underscore separators, and make the result a case-insensitive CQL name, for example Product => product, productId => product_id.
UPPER_CAMEL_CASE Divide the Java name into words, splitting on upper-case characters; capitalize every word; then concatenate the words and make the result a case-sensitive CQL name, for example Product => "Product", productId => "ProductId".
UPPER_CASE Upper-case everything, and make the result a case-sensitive CQL name, for example Product => "PRODUCT", productId => "PRODUCTID".
UPPER_SNAKE_CASE Divide the Java name into words, splitting on upper-case characters; upper-case everything; then concatenate the words with underscore separators, and make the result a case-sensitive CQL name, for example Product => "PRODUCT", productId => "PRODUCT_ID".

Method Summary

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

CASE_INSENSITIVE

public static final NamingConvention CASE_INSENSITIVE

Uses the Java name as-is, as a case-insensitive CQL name, for example Product => Product, productId => productId.

In practice this is the same as lower-casing everything (product, productid), but it makes generated queries a bit easier to read.

EXACT_CASE

public static final NamingConvention EXACT_CASE

Uses the Java name as-is, as a case-sensitive CQL name, for example Product => "Product", productId => "productId".

Use this if your schema uses camel case and you want to preserve capitalization in table names.

LOWER_CAMEL_CASE

public static final NamingConvention LOWER_CAMEL_CASE

Divide the Java name into words, splitting on upper-case characters; capitalize every word except the first; then concatenate the words and make the result a case-sensitive CQL name, for example Product => "product", productId => "productId".

UPPER_CAMEL_CASE

public static final NamingConvention UPPER_CAMEL_CASE

Divide the Java name into words, splitting on upper-case characters; capitalize every word; then concatenate the words and make the result a case-sensitive CQL name, for example Product => "Product", productId => "ProductId".

SNAKE_CASE_INSENSITIVE

public static final NamingConvention SNAKE_CASE_INSENSITIVE

Divide the Java name into words, splitting on upper-case characters; lower-case everything; then concatenate the words with underscore separators, and make the result a case-insensitive CQL name, for example Product => product, productId => product_id.

UPPER_SNAKE_CASE

public static final NamingConvention UPPER_SNAKE_CASE

Divide the Java name into words, splitting on upper-case characters; upper-case everything; then concatenate the words with underscore separators, and make the result a case-sensitive CQL name, for example Product => "PRODUCT", productId => "PRODUCT_ID".

UPPER_CASE

public static final NamingConvention UPPER_CASE

Upper-case everything, and make the result a case-sensitive CQL name, for example Product => "PRODUCT", productId => "PRODUCTID".

Method Detail

values

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

Returns:

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

valueOf

public static NamingConvention valueOf(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:

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

NullPointerException - if the argument is null