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>

@API(status=STABLE,
     since="0.6.0")
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.VersionFormat, 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, versionFormat, versionPlacement

Method Summary

Modifier and Type	Method	Description
EnumBuilder	addEnumConstants(String... enumConstantNames)	Adds the enumConstantNames to the currently uncommitted enum class.
protected @NotNull String	generateFileContent(io.github.chrimle.semver.SemVer semVer)	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.
EnumBuilder	updateEnumConstant(String oldEnumConstant, String newEnumConstant)	Updates the oldEnumConstant into newEnumConstant in the currently uncommitted class.

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

commit, commit, determineSemVerChange, generateClassFile, getSemVer, resolveEffectiveClassName, resolveEffectivePackageName, resolveFullyQualifiedClassName, setSemVer, setVersionFormat, setVersionPlacement, updateClassName, updateDirectory, updatePackageName, validateAdditionalPredicates

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.chrimle.classforge.Builder

commit

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

@Contract("null -> fail; _ -> this")
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.

IllegalArgumentException - if enumConstantNames is empty.

IllegalArgumentException - if enumConstantNames contain a String which is null.

IllegalArgumentException - if enumConstantNames contain a String which does not match the RegEx "^([A-Za-z]|(_+[A-Za-z0-9]))[A-Z_a-z0-9]*$".

IllegalArgumentException - if enumConstantNames contain a String which does not exist in the currently uncommitted class.

Since:

0.3.0

removeEnumConstants

@Contract("null -> fail; _ -> this")
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.

IllegalArgumentException - if enumConstantNames is empty.

IllegalArgumentException - if enumConstantNames contain a String which is null.

IllegalArgumentException - if enumConstantNames contain a String which does not exist in the currently uncommitted class.

Since:

0.3.0

updateEnumConstant

@Contract("null, _ -> fail; _, null -> fail; _, _ -> this")
public EnumBuilder updateEnumConstant(String oldEnumConstant,
 String newEnumConstant)

Updates the oldEnumConstant into newEnumConstant in the currently uncommitted class.

Parameters:

oldEnumConstant - to be removed.

newEnumConstant - to be added.

Returns:

this Builder.

Throws:

IllegalArgumentException - if oldEnumConstant is null.

IllegalArgumentException - if oldEnumConstant does not exist.

IllegalArgumentException - if newEnumConstant is null.

IllegalArgumentException - if newEnumConstant does not match the RegEx "^([A-Za-z]|(_+[A-Za-z0-9]))[A-Z_a-z0-9]*$".

IllegalArgumentException - if newEnumConstant already exists.

Since:

0.5.0

self

@Contract(value=" -> this",
          pure=true)
protected EnumBuilder self()

Description copied from class: AbstractBuilder

Returns this as AbstractBuilder.

Specified by:

self in class AbstractBuilder<EnumBuilder>

Returns:

this.

generateFileContent

@NotNull
protected @NotNull String generateFileContent(io.github.chrimle.semver.SemVer semVer)

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>

Parameters:

semVer - for the new class.

Returns:

the file contents as a String.