Package org.refcodes.textual

Interface CaseStyleBuilder

All Superinterfaces:

CaseAccessor, CaseAccessor.CaseBuilder<CaseStyleBuilder>, CaseAccessor.CaseMutator, CaseAccessor.CaseProperty, org.refcodes.mixin.TextAccessor, org.refcodes.mixin.TextAccessor.TextBuilder<CaseStyleBuilder>, org.refcodes.mixin.TextAccessor.TextMutator, org.refcodes.mixin.TextAccessor.TextProperty

All Known Implementing Classes:

CaseStyleBuilderImpl

public interface CaseStyleBuilder
extends org.refcodes.mixin.TextAccessor.TextProperty, org.refcodes.mixin.TextAccessor.TextBuilder<CaseStyleBuilder>, CaseAccessor.CaseProperty, CaseAccessor.CaseBuilder<CaseStyleBuilder>

Converts a key to the format of a String to the desired case. The state of the Case accessible via CaseAccessor.getCase() has not an effect on some of the methods. For example it has no effect on toCamelCase(), but it has an effect in toSnakeCase(String).

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.textual.CaseAccessor

CaseAccessor.CaseBuilder<B extends CaseAccessor.CaseBuilder<?>>, CaseAccessor.CaseMutator, CaseAccessor.CaseProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TextAccessor

org.refcodes.mixin.TextAccessor.TextBuilder<B extends org.refcodes.mixin.TextAccessor.TextBuilder<B>>, org.refcodes.mixin.TextAccessor.TextMutator, org.refcodes.mixin.TextAccessor.TextProperty

Method Summary

Modifier and Type	Method	Description
java.lang.String	toCamelCase()	Converts the text as of TextAccessor.getText() to camel-case ("camelCase").
java.lang.String	toCamelCase(java.lang.String aKey)	Converts the provided key as of TextAccessor.getText() to camel-case ("camelCase").
java.lang.String	toKebabCase()	Converts the key as of TextAccessor.getText() to kebab-case, either in upper case as of "KEBAB-CASE" or in lower-case as of "kebab-case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).
java.lang.String	toKebabCase(java.lang.String aKey)	Converts the provided key as of TextAccessor.getText() to kebab-case, either in upper case as of "KEBAB-CASE" or in lower-case as of "kebab-case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).
java.lang.String	toPascalCase()	Converts the key as of TextAccessor.getText() to pascal-case ("PascalCase").
java.lang.String	toPascalCase(java.lang.String aKey)	Converts the provided key as of TextAccessor.getText() to pascal-case ("PascalCase").
java.lang.String	toSnakeCase()	Converts the key as of TextAccessor.getText() to snake-case, either in upper case as of "SNAKE_CASE" or in lower-case as of "snake_case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).
java.lang.String	toSnakeCase(java.lang.String aKey)	Converts the provided key as of TextAccessor.getText() to snake-case, either in upper case as of "SNAKE_CASE" or in lower-case as of "snake_case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).
default CaseStyleBuilder	withCase(Case aCase)	Sets the rows Case to use returns this builder as of the Builder-Pattern.

Methods inherited from interface org.refcodes.textual.CaseAccessor

getCase

Methods inherited from interface org.refcodes.textual.CaseAccessor.CaseMutator

setCase

Methods inherited from interface org.refcodes.mixin.TextAccessor

getText

Methods inherited from interface org.refcodes.mixin.TextAccessor.TextBuilder

withText

Methods inherited from interface org.refcodes.mixin.TextAccessor.TextMutator

setText

Method Detail

toCamelCase

java.lang.String toCamelCase()

Converts the text as of TextAccessor.getText() to camel-case ("camelCase").

Returns:

The camel-case representation of the according key.

toPascalCase

java.lang.String toPascalCase()

Converts the key as of TextAccessor.getText() to pascal-case ("PascalCase").

Returns:

The camel-case representation of the according key.

toSnakeCase

java.lang.String toSnakeCase()

Converts the key as of TextAccessor.getText() to snake-case, either in upper case as of "SNAKE_CASE" or in lower-case as of "snake_case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).

Returns:

The pascal-case representation of the according key.

toKebabCase

java.lang.String toKebabCase()

Converts the key as of TextAccessor.getText() to kebab-case, either in upper case as of "KEBAB-CASE" or in lower-case as of "kebab-case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).

Returns:

The kebab-case representation of the according key.

toCamelCase

java.lang.String toCamelCase(java.lang.String aKey)

Converts the provided key as of TextAccessor.getText() to camel-case ("camelCase").

Parameters:

aKey - The key to be converted.

Returns:

The camel-case representation of the according key.

toPascalCase

java.lang.String toPascalCase(java.lang.String aKey)

Converts the provided key as of TextAccessor.getText() to pascal-case ("PascalCase").

Parameters:

aKey - The key to be converted.

Returns:

The pascal-case representation of the according key.

toSnakeCase

java.lang.String toSnakeCase(java.lang.String aKey)

Converts the provided key as of TextAccessor.getText() to snake-case, either in upper case as of "SNAKE_CASE" or in lower-case as of "snake_case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).

Parameters:

aKey - The key to be converted.

Returns:

The snake-case representation of the according key.

toKebabCase

java.lang.String toKebabCase(java.lang.String aKey)

Converts the provided key as of TextAccessor.getText() to kebab-case, either in upper case as of "KEBAB-CASE" or in lower-case as of "kebab-case", depending on the Case property (as of CaseAccessor.CaseMutator.setCase(Case) and CaseAccessor.getCase()).

Parameters:

aKey - The key to be converted.

Returns:

The kebab-case representation of the according key.

withCase

default CaseStyleBuilder withCase(Case aCase)

Sets the rows Case to use returns this builder as of the Builder-Pattern.

Specified by:

withCase in interface CaseAccessor.CaseBuilder<CaseStyleBuilder>

Parameters:

aCase - The Case to be used when printing a row or the header.

Returns:

This CaseAccessor.CaseBuilder instance to continue configuration.