Index (ClassForge 0.4.0 API)

A B C D E F G H I M N P R S T U V W
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.

B

Builder<T extends Builder<T>> - Interface in io.github.chrimle.classforge: Builder of a Java class - which MAY generate a class, enum or record.
Builder.VersionPlacement - Enum Class in io.github.chrimle.classforge: The placement of version information in generated classes.

C

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() - Constructor for class io.github.chrimle.classforge.ClassForge
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 class.
commit() - Method in interface io.github.chrimle.classforge.Builder: Commits the currently uncommitted class.

D

determineSemVerChange() - Method in class io.github.chrimle.classforge.AbstractBuilder: Determines the SemVer.Change for the currently uncommitted changes.
directory - Variable in class io.github.chrimle.classforge.AbstractBuilder: The directory of the currently uncommitted class.

E

EnumBuilder - Class in io.github.chrimle.classforge: Builder of Java enum classes.
equals(Object) - Method in record class io.github.chrimle.classforge.semver.SemVer: Indicates whether some other object is "equal to" this one.

F

FileWriter - Class in io.github.chrimle.classforge.utils: Writes content to files - creating directories and files if needed.
FileWriter() - Constructor for class io.github.chrimle.classforge.utils.FileWriter

G

generateClassFile() - Method in class io.github.chrimle.classforge.AbstractBuilder: Generates a .java class file for the currently uncommitted class.
generateFileContent() - Method in class io.github.chrimle.classforge.AbstractBuilder: Generates the complete file contents for a .java file for the currently uncommitted class.
generateFileContent() - Method in class io.github.chrimle.classforge.ClassBuilder
generateFileContent() - Method in class io.github.chrimle.classforge.EnumBuilder

H

hashCode() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns a hash code value for this object.

I

incrementMajor() - Method in record class io.github.chrimle.classforge.semver.SemVer: Creates a new SemVer with the SemVer.major-version incremented.
incrementMinor() - Method in record class io.github.chrimle.classforge.semver.SemVer: Creates a new SemVer with the SemVer.minor-version incremented.
incrementPatch() - Method in record class io.github.chrimle.classforge.semver.SemVer: Creates a new SemVer with the SemVer.patch-version incremented.
incrementVersion(SemVer.Change) - Method in record class io.github.chrimle.classforge.semver.SemVer: Creates a new SemVer with the corresponding version incremented.
io.github.chrimle.classforge - package io.github.chrimle.classforge
io.github.chrimle.classforge.semver - package io.github.chrimle.classforge.semver
io.github.chrimle.classforge.utils - package io.github.chrimle.classforge.utils

M

major() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns the value of the major record component.
MAJOR - Enum constant in enum class io.github.chrimle.classforge.semver.SemVer.Change: MAJOR change.
minor() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns the value of the minor record component.
MINOR - Enum constant in enum class io.github.chrimle.classforge.semver.SemVer.Change: MINOR change.

N

NONE - Enum constant in enum class io.github.chrimle.classforge.Builder.VersionPlacement: Default. Version information is excluded.

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 of v{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 packageName of the currently uncommitted class.
patch() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns the value of the patch record component.
PATCH - Enum constant in enum class io.github.chrimle.classforge.semver.SemVer.Change: PATCH change.

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.
resolveEffectivePackageName() - Method in class io.github.chrimle.classforge.AbstractBuilder: Resolves the effective package name for the currently uncommitted class.
resolveFullyQualifiedClassName() - 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.
SemVer - Record Class in io.github.chrimle.classforge.semver: Represents a Semantic Version (SemVer).
SemVer(int, int, int) - Constructor for record class io.github.chrimle.classforge.semver.SemVer: Constructs a valid SemVer instance.
SemVer.Change - Enum Class in io.github.chrimle.classforge.semver: The type of change.
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.

T

toShortVersionString() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns this SemVer as a String in the format: v{major}.{minor}.{patch} - where trailing zero sub-versions are omitted.
toString() - Method in record class io.github.chrimle.classforge.semver.SemVer: Returns this SemVer as a String in the format: v{major}.{minor}.{patch}.

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.
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 Predicates for determining the validity of the currently uncommitted class.
validateAdditionalPredicates() - Method in class io.github.chrimle.classforge.ClassBuilder
validateAdditionalPredicates() - Method in class io.github.chrimle.classforge.EnumBuilder
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.semver.SemVer.Change: 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.
values() - Static method in enum class io.github.chrimle.classforge.semver.SemVer.Change: 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 versionPlacement of the currently uncommitted class.

W

writeToFile(String, String, String) - Static method in class io.github.chrimle.classforge.utils.FileWriter: Writes the content to a file at directory and the package-name from the fullyQualifiedClassName.
writeToFile(Path, String) - Static method in class io.github.chrimle.classforge.utils.FileWriter: Writes the content to a file at filePath.

A B C D E F G H I M N P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values