io.micronaut.serde.config.naming

Interface PropertyNamingStrategy

All Known Implementing Classes:

IdentityStrategy, KebabCaseStrategy, LowerCamelCaseStrategy, LowerCaseStrategy, LowerDotCaseStrategy, SnakeCaseStrategy, UpperCamelCaseStrategy, UpperCamelCaseStrategyWithSpaces

public interface PropertyNamingStrategy

Allows defining a custom naming strategy for properties.

Note that implementations are used only at build time and not at runtime, therefore adding a new implementation entails ensuring the implementation exists on the annotation processor classpath

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyNamingStrategy	IDENTITY Property name as is without changes.
static PropertyNamingStrategy	KEBAB_CASE Lowercase, separated by hyphens.
static PropertyNamingStrategy	LOWER_CAMEL_CASE lower first letter, but camel case.
static PropertyNamingStrategy	LOWER_CASE All lower case.
static PropertyNamingStrategy	LOWER_DOT_CASE Lowercase, separated by dots.
static PropertyNamingStrategy	SNAKE_CASE Lowercase, separated by underscores.
static PropertyNamingStrategy	UPPER_CAMEL_CASE upper first letter, but camel case.
static PropertyNamingStrategy	UPPER_CAMEL_CASE_WITH_SPACES upper first letter, but camel case with a space between.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<PropertyNamingStrategy>	forName(java.lang.String namingStrategy) Return an existing naming strategy for each name.
java.lang.String	translate(io.micronaut.core.annotation.AnnotatedElement element) Translate the given name into the desired format.

Field Detail

IDENTITY

static final PropertyNamingStrategy IDENTITY

Property name as is without changes.

UPPER_CAMEL_CASE_WITH_SPACES

static final PropertyNamingStrategy UPPER_CAMEL_CASE_WITH_SPACES

upper first letter, but camel case with a space between. Example: Foo Bar.

LOWER_CAMEL_CASE

static final PropertyNamingStrategy LOWER_CAMEL_CASE

lower first letter, but camel case. Example: fooBar.

UPPER_CAMEL_CASE

static final PropertyNamingStrategy UPPER_CAMEL_CASE

upper first letter, but camel case. Example: FooBar.

SNAKE_CASE

static final PropertyNamingStrategy SNAKE_CASE

Lowercase, separated by underscores. Example: foo_bar.

LOWER_DOT_CASE

static final PropertyNamingStrategy LOWER_DOT_CASE

Lowercase, separated by dots. Example: foo.bar.

KEBAB_CASE

static final PropertyNamingStrategy KEBAB_CASE

Lowercase, separated by hyphens. Example: foo-bar.

LOWER_CASE

static final PropertyNamingStrategy LOWER_CASE

All lower case. Example: foobar.

Method Detail

translate

@NonNull
java.lang.String translate(@NonNull
                                    io.micronaut.core.annotation.AnnotatedElement element)

Translate the given name into the desired format.

Parameters:

element - The annotated element to translate

Returns:

The translated name

forName

static java.util.Optional<PropertyNamingStrategy> forName(java.lang.String namingStrategy)

Return an existing naming strategy for each name.

Parameters:

namingStrategy - The naming strategy name.

Returns:

The naming strategy