Package io.github.chrimle.classforge

Class EnumBuilder

java.lang.Object

io.github.chrimle.classforge.AbstractBuilder<EnumBuilder>

io.github.chrimle.classforge.EnumBuilder

All Implemented Interfaces:

Builder<EnumBuilder>

public final class EnumBuilder
extends AbstractBuilder<EnumBuilder>

Builder of Java enum classes.

Since:

0.1.0

Author:

Chrimle

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.chrimle.classforge.Builder

Builder.VersionPlacement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VALID_ENUM_CONSTANT_NAME_REGEX	The RegularExpression (RegEx) for determining validity of enum constant-names.

Fields inherited from class io.github.chrimle.classforge.AbstractBuilder

className, directory, packageName, reservedClassNames, semVer, versionPlacement

Method Summary

Modifier and Type	Method	Description
EnumBuilder	addEnumConstants(String... enumConstantNames)	Adds the enumConstantNames to the currently uncommitted enum class.
protected String	generateFileContent()	Generates the complete file contents for a .java file for the currently uncommitted class.
EnumBuilder	removeEnumConstants(String... enumConstantNames)	Removes the enumConstantNames from the currently uncommitted enum class.
protected EnumBuilder	self()	Returns this as AbstractBuilder.
protected void	validateAdditionalPredicates()	Validates additional Predicates for determining the validity of the currently uncommitted class.

Methods inherited from class io.github.chrimle.classforge.AbstractBuilder

commit, determineSemVerChange, generateClassFile, resolveEffectivePackageName, resolveFullyQualifiedClassName, setVersionPlacement, updateClassName, updateDirectory, updatePackageName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VALID_ENUM_CONSTANT_NAME_REGEX

public static final String VALID_ENUM_CONSTANT_NAME_REGEX

The RegularExpression (RegEx) for determining validity of enum constant-names.

Since:

0.2.0

See Also:

• Constant Field Values

Method Details

addEnumConstants

public EnumBuilder addEnumConstants(String... enumConstantNames)

Adds the enumConstantNames to the currently uncommitted enum class.

Parameters:

enumConstantNames - to add.

Returns:

this Builder.

Throws:

IllegalArgumentException - if enumConstantNames is null, empty, or contains Strings which are null, does not match the RegEx "^([A-Za-z]|(_+[A-Za-z0-9]))[A-Z_a-z0-9]*$" or the currently uncommitted class already has an enum constant with the same name.

Since:

0.3.0

removeEnumConstants

public EnumBuilder removeEnumConstants(String... enumConstantNames)

Removes the enumConstantNames from the currently uncommitted enum class.

Parameters:

enumConstantNames - to remove.

Returns:

this Builder.

Throws:

IllegalArgumentException - if enumConstantNames is null, empty, or contains Strings which are null, does not match the RegEx "^([A-Za-z]|(_+[A-Za-z0-9]))[A-Z_a-z0-9]*$" or the currently uncommitted class does not have the enum constant to be removed.

Since:

0.3.0

self

protected EnumBuilder self()

Description copied from class: AbstractBuilder

Returns this as AbstractBuilder.

Specified by:

self in class AbstractBuilder<EnumBuilder>

Returns:

this.

validateAdditionalPredicates

protected void validateAdditionalPredicates()

Description copied from class: AbstractBuilder

Validates additional Predicates for determining the validity of the currently uncommitted class.

Specified by:

validateAdditionalPredicates in class AbstractBuilder<EnumBuilder>

generateFileContent

protected String generateFileContent()

Description copied from class: AbstractBuilder

Generates the complete file contents for a .java file for the currently uncommitted class.

Specified by:

generateFileContent in class AbstractBuilder<EnumBuilder>

Returns:

the file contents as a String.