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
enumConstantNames
to the currently uncommitted enum class. - alreadyExistsException(String, String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException
-instance with amessage
representing 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
,enum
orrecord
. - Builder.VersionFormat - Enum Class in io.github.chrimle.classforge
-
The
SemVer
format of a generated class. - Builder.VersionPlacement - Enum Class in io.github.chrimle.classforge
-
The
SemVer
placement in generated classes.
C
- CLASS - Enum constant in enum class io.github.chrimle.classforge.ClassForge.ClassType
-
A Java
class
. - CLASS_NAME_SUFFIX - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The
SemVer
is appended as a suffix to the generated class name. - 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
. - ClassForge.ClassType - Enum Class in io.github.chrimle.classforge
-
A type of Java class which can be generated.
- className - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
className
of 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.
- COMPLETE - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionFormat
-
The complete version - always displayed as
{major}.{minor}.{patch}
.
D
- determineSemVerChange() - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Determines the
Change
for the currently uncommitted changes. - directory - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
directory
of the currently uncommitted class. - doesNotExistException(String, String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException
-instance with amessage
representing a Does Not Exist-exception.
E
- ENUM - Enum constant in enum class io.github.chrimle.classforge.ClassForge.ClassType
-
A Java
enum
class. - EnumBuilder - Class in io.github.chrimle.classforge
-
Builder of Java
enum
classes. - 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
.java
class file for the currently uncommitted class. - generateFileContent(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Generates the complete file contents for a
.java
file 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
semVer
of the currently uncommitted class. - getSemVer() - Method in interface io.github.chrimle.classforge.Builder
-
Gets the
semVer
of 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
N
- newBuilder(ClassForge.ClassType) - Static method in class io.github.chrimle.classforge.ClassForge
-
Creates a new
Builder
instance for generatingclassType
s. - newClassBuilder() - Static method in class io.github.chrimle.classforge.ClassForge
-
Creates a new
Builder
instance for generating Java classes. - newEnumBuilder() - Static method in class io.github.chrimle.classforge.ClassForge
-
Creates a new
Builder
instance for generating Javaenum
classes. - 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 amessage
representing a Not Matching RegEx-exception. - nullException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException
-instance with amessage
representing a Null-exception. - nullOrEmptyException(String) - Static method in class io.github.chrimle.classforge.internal.ExceptionFactory
-
Creates a new
IllegalArgumentException
-instance with amessage
representing a Null or Empty-exception.
P
- PACKAGE_NAME_SUFFIX - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
The
SemVer
is appended as a suffix to the generated classpackage
-name. - packageName - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
packageName
of the currently uncommitted class.
R
- removeEnumConstants(String...) - Method in class io.github.chrimle.classforge.EnumBuilder
-
Removes the
enumConstantNames
from 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 amessage
representing 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
semVer
of the previously committed class. - setSemVer(SemVer) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Sets the
semVer
of the currently uncommitted class. - setSemVer(SemVer) - Method in interface io.github.chrimle.classforge.Builder
-
Sets the
semVer
of the currently uncommitted class. - setVersionFormat(Builder.VersionFormat) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Sets the
versionFormat
of the currently uncommitted class. - setVersionFormat(Builder.VersionFormat) - Method in interface io.github.chrimle.classforge.Builder
-
Sets the
versionFormat
of the currently uncommitted class. - setVersionPlacement(Builder.VersionPlacement) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Sets the
versionPlacement
of the currently uncommitted class. - setVersionPlacement(Builder.VersionPlacement) - Method in interface io.github.chrimle.classforge.Builder
-
Sets the
versionPlacement
of the currently uncommitted class. - SHORT - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionFormat
-
The short version - omitting trailing zeroes.
U
- updateClassName(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
className
of the currently uncommitted class. - updateClassName(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
className
of the currently uncommitted class. - updateDirectory(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
directory
of the currently uncommitted class. - updateDirectory(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
directory
of the currently uncommitted class. - updateEnumConstant(String, String) - Method in class io.github.chrimle.classforge.EnumBuilder
-
Updates the
oldEnumConstant
intonewEnumConstant
in the currently uncommitted class. - updatePackageName(String) - Method in class io.github.chrimle.classforge.AbstractBuilder
-
Updates the
packageName
of the currently uncommitted class. - updatePackageName(String) - Method in interface io.github.chrimle.classforge.Builder
-
Updates the
packageName
of 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
Predicate
s for determining the validity of the currently uncommitted class. - valueOf(String) - Static method in enum class io.github.chrimle.classforge.Builder.VersionFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.chrimle.classforge.Builder.VersionPlacement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.chrimle.classforge.ClassForge.ClassType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.chrimle.classforge.Builder.VersionFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- 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.
- values() - Static method in enum class io.github.chrimle.classforge.ClassForge.ClassType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- versionFormat - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
versionFormat
of the currently uncommitted class. - versionPlacement - Variable in class io.github.chrimle.classforge.AbstractBuilder
-
The
versionPlacement
of the currently uncommitted class.
W
- writeToFile(String, String, String) - Static method in class io.github.chrimle.classforge.internal.FileWriter
-
Writes the
content
to a file atdirectory
and thepackage
-name from thefullyQualifiedClassName
. - writeToFile(Path, String) - Static method in class io.github.chrimle.classforge.internal.FileWriter
-
Writes the
content
to a file atfilePath
.
All Classes and Interfaces|All Packages|Constant Field Values