Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractBuilder<T extends Builder<T>> - Class in io.github.chrimle.classforge
-
Abstract class for building and generating Java classes.
- AbstractBuilder() - Constructor for class io.github.chrimle.classforge.AbstractBuilder
- addEnumConstants(String...) - Method in class io.github.chrimle.classforge.EnumBuilder
-
Adds the
enumConstantNamesto the currently uncommitted enum class. - alreadyExistsException(String, String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting an Already Exists-exception.
B
- Builder<T extends Builder<T>> - Interface in io.github.chrimle.classforge
-
Builder of a Java class - which MAY generate a
class,enumorrecord. - Builder.VersionPlacement - Enum Class in io.github.chrimle.classforge
-
The placement of version information in generated classes.
C
- CLASS_NAME_WITH_COMPLETE_VERSION - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The complete version is included as a suffix in the class-name - always consisting of
V{major}_{minor}_{patch}. - CLASS_NAME_WITH_SHORTENED_VERSION - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The shortened version is included as a suffix in the class-name - omitting trailing zeros i.e.
- ClassBuilder - Class in io.github.chrimle.classforge
-
Builder of Java classes (
class). - ClassForge - Class in io.github.chrimle.classforge
-
The single-entrypoint for generating Java classes via
io.github.chrimle:class-forge. - className - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
classNameof the currently uncommitted class. - commit() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Commits the currently uncommitted changes as a new class.
- commit() - Method in interface io.github.chrimle.classforge.Builder
-
Commits the currently uncommitted changes as a new class.
- commit(Change) - Method in interface io.github.chrimle.classforge.Builder
-
Commits the currently uncommitted changes as a new class.
- commit(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Commits the currently uncommitted changes as a new class.
- commit(SemVer) - Method in interface io.github.chrimle.classforge.Builder
-
Commits the currently uncommitted changes as a new class.
D
- determineSemVerChange() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Determines the
Changefor the currently uncommitted changes. - directory - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
directoryof the currently uncommitted class. - doesNotExistException(String, String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Does Not Exist-exception.
E
- EnumBuilder - Class in io.github.chrimle.classforge
-
Builder of Java
enumclasses. - ExceptionFactory - Class in io.github.chrimle.classforge.internal
-
Factory-class for instantiating
Exception-classes with message presets.
F
- FileWriter - Class in io.github.chrimle.classforge.internal
-
Writes content to files - creating directories and files if needed.
- FileWriter() - Constructor for class io.github.chrimle.classforge.internal.FileWriter
G
- generateClassFile(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Generates a
.javaclass file for the currently uncommitted class. - generateFileContent(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Generates the complete file contents for a
.javafile for the currently uncommitted class. - generateFileContent(SemVer) - Method in class io.github.chrimle.classforge.ClassBuilder
- generateFileContent(SemVer) - Method in class io.github.chrimle.classforge.EnumBuilder
- getSemVer() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Gets the
semVerof the currently uncommitted class. - getSemVer() - Method in interface io.github.chrimle.classforge.Builder
-
Gets the
semVerof the currently uncommitted class.
I
- io.github.chrimle.classforge - package io.github.chrimle.classforge
- io.github.chrimle.classforge.internal - package io.github.chrimle.classforge.internal
L
- lessThanZeroException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Less Than Zero-exception.
N
- newClassBuilder() - Static method in class io.github.chrimle.classforge.ClassForge
-
Creates a new
Builderinstance for generating Java classes. - newEnumBuilder() - Static method in class io.github.chrimle.classforge.ClassForge
-
Creates a new
Builderinstance for generating Javaenumclasses. - NONE - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
Default. Version information is excluded.
- notMatchingRegExException(String, String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Not Matching RegEx-exception. - nullException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Null-exception. - nullOrEmptyException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Null or Empty-exception.
P
- PACKAGE_NAME_WITH_COMPLETE_VERSION - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The complete version is included in the
package-name - always consisting ofv{major}_{minor}_{patch}. - PACKAGE_NAME_WITH_SHORTENED_VERSION - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The shortened version is included in the
package-name - omitting trailing zeros i.e. - packageName - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
packageNameof the currently uncommitted class.
R
- removeEnumConstants(String...) - Method in class io.github.chrimle.classforge.EnumBuilder
-
Removes the
enumConstantNamesfrom the currently uncommitted enum class. - RESERVED_KEYWORDS - Static variable in class io.github.chrimle.classforge.ClassForge
-
Keywords reserved by the Java Language.
- reservedClassNames - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The collection of previously committed classes.
- reservedJavaKeywordException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException-instance with amessagerepresenting a Reserved Java Keyword-exception. - resolveEffectiveClassName(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Resolves the effective class name for the currently uncommitted class.
- resolveEffectivePackageName(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Resolves the effective package name for the currently uncommitted class.
- resolveFullyQualifiedClassName(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Resolves the Fully Qualified Class Name (FQCN) for the currently uncommitted class.
S
- self() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Returns this as
AbstractBuilder. - self() - Method in class io.github.chrimle.classforge.ClassBuilder
- self() - Method in class io.github.chrimle.classforge.EnumBuilder
- semVer - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
semVerof the previously committed class. - setSemVer(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Sets the
semVerof the currently uncommitted class. - setSemVer(SemVer) - Method in interface io.github.chrimle.classforge.Builder
-
Sets the
semVerof the currently uncommitted class. - setVersionPlacement(Builder.VersionPlacement) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Sets the
versionPlacementof the currently uncommitted class. - setVersionPlacement(Builder.VersionPlacement) - Method in interface io.github.chrimle.classforge.Builder
-
Sets the
versionPlacementof the currently uncommitted class.
U
- updateClassName(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
classNameof the currently uncommitted class. - updateClassName(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
classNameof the currently uncommitted class. - updateDirectory(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
directoryof the currently uncommitted class. - updateDirectory(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
directoryof the currently uncommitted class. - updateEnumConstant(String, String) - Method in class io.github.chrimle.classforge.EnumBuilder
-
Updates the
oldEnumConstantintonewEnumConstantin the currently uncommitted class. - updatePackageName(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
packageNameof the currently uncommitted class. - updatePackageName(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
packageNameof the currently uncommitted class.
V
- VALID_CLASS_NAME_REGEX - Static variable in class io.github.chrimle.classforge.ClassForge
-
The RegularExpression (RegEx) for determining validity of class-names.
- VALID_ENUM_CONSTANT_NAME_REGEX - Static variable in class io.github.chrimle.classforge.EnumBuilder
-
The RegularExpression (RegEx) for determining validity of enum constant-names.
- VALID_PACKAGE_NAME_REGEX - Static variable in class io.github.chrimle.classforge.ClassForge
-
The RegularExpression (RegEx) for determining validity of package-names.
- validateAdditionalPredicates() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Validates additional
Predicates for determining the validity of the currently uncommitted class. - valueOf(String) - Static method in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- versionPlacement - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
versionPlacementof the currently uncommitted class.
W
- writeToFile(String, String, String) - Static method in class io.github.chrimle.classforge.internal.FileWriter
-
Writes the
contentto a file atdirectoryand thepackage-name from thefullyQualifiedClassName. - writeToFile(Path, String) - Static method in class io.github.chrimle.classforge.internal.FileWriter
-
Writes the
contentto a file atfilePath.
All Classes and Interfaces|All Packages|Constant Field Values