io.github.fablabsmc.fablabs.api.fiber.v1.annotation

Interface SettingNamingConvention

All Known Implementing Classes:

LowercaseConvention, NoNamingConvention, SnakeCaseConvention

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface SettingNamingConvention

A setting naming convention decides how a setting is named based upon the variable it was created from.

Java fields are usually lowerCamelCase, while developers might want their configuration to use snake_case or lowercase. Classes implementing this interface are required to make the conversion from lowerCamelCase to another format.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	CAMEL_WORD_START
static SettingNamingConvention	LOWERCASE A naming convention that converts all characters to lowercase.
static SettingNamingConvention	NONE A naming convention that does not modify any names.
static SettingNamingConvention	SNAKE_CASE A naming convention that converts java-styled lowerCamelCase names and Proper case names to snake_case.

Method Summary

Modifier and Type	Method and Description
String	name(String name) For the given lowerCamelCase name, returns a name using the convention defined by this object.

Field Detail

LOWERCASE

static final SettingNamingConvention LOWERCASE

A naming convention that converts all characters to lowercase.

NONE

static final SettingNamingConvention NONE

A naming convention that does not modify any names.

CAMEL_WORD_START

static final Pattern CAMEL_WORD_START

SNAKE_CASE

static final SettingNamingConvention SNAKE_CASE

A naming convention that converts java-styled lowerCamelCase names and Proper case names to snake_case.

Method Detail

name

String name(String name)

For the given lowerCamelCase name, returns a name using the convention defined by this object.

Parameters:

name - The name, in lower camel case.

Returns:

The name, formatted according to the convention defined by this object.