Package io.github.chrimle.classforge

Class AbstractBuilder<T extends Builder<T>>

java.lang.Object
io.github.chrimle.classforge.AbstractBuilder<T>
All Implemented Interfaces:
Builder<T>
Direct Known Subclasses:
ClassBuilder, EnumBuilder
@API(status=STABLE, since="0.6.0") public abstract sealed class AbstractBuilder<T extends Builder<T>> extends Object implements Builder<T> permits ClassBuilder, EnumBuilder
Abstract class for building and generating Java classes.
Since:
0.1.0
Author:
Chrimle

  • Field Details

    • reservedClassNames

      protected final Set<String> reservedClassNames
      The collection of previously committed classes.

    • semVer

      protected io.github.chrimle.semver.SemVer semVer
      The semVer of the previously committed class. Starts at 0.0.0.

    • versionPlacement

      protected Builder.VersionPlacement versionPlacement
      The versionPlacement of the currently uncommitted class.

    • directory

      protected String directory
      The directory of the currently uncommitted class.

    • packageName

      protected String packageName
      The packageName of the currently uncommitted class.

    • className

      protected String className
      The className of the currently uncommitted class.

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • getSemVer

      @NotNull public io.github.chrimle.semver.SemVer getSemVer()
      Gets the semVer of the currently uncommitted class. NOTE: the semVer will be updated when committing the changes.
      Specified by:
      getSemVer in interface Builder<T extends Builder<T>>
      Returns:
      the semVer of the class.

    • setSemVer

      @Contract("null -> fail; _ -> this") public T setSemVer(io.github.chrimle.semver.SemVer semVer)
      Sets the semVer of the currently uncommitted class.

      NOTE: the semVer will be updated when committing the changes.

      Specified by:
      setSemVer in interface Builder<T extends Builder<T>>
      Parameters:
      semVer - for the class.
      Returns:
      this Builder.

    • setVersionPlacement

      @Contract("_ -> this") public T setVersionPlacement(Builder.VersionPlacement versionPlacement)
      Sets the versionPlacement of the currently uncommitted class.

      Default: Builder.VersionPlacement.NONE.

      Specified by:
      setVersionPlacement in interface Builder<T extends Builder<T>>
      Parameters:
      versionPlacement - for the class.
      Returns:
      this Builder.

    • updateDirectory

      @Contract("null -> fail; _ -> this") public T updateDirectory(String directory)
      Updates the directory of the currently uncommitted class.
      Specified by:
      updateDirectory in interface Builder<T extends Builder<T>>
      Parameters:
      directory - of the class.
      Returns:
      this Builder.

    • updatePackageName

      @Contract("null -> fail; _ -> this") public T updatePackageName(String packageName)
      Updates the packageName of the currently uncommitted class.
      Specified by:
      updatePackageName in interface Builder<T extends Builder<T>>
      Parameters:
      packageName - of the class.
      Returns:
      this Builder.

    • updateClassName

      @Contract("null -> fail; _ -> this") public T updateClassName(String className)
      Updates the className of the currently uncommitted class.
      Specified by:
      updateClassName in interface Builder<T extends Builder<T>>
      Parameters:
      className - of the class.
      Returns:
      this Builder.

    • commit

      @Contract(" -> this") public T commit()
      Commits the currently uncommitted changes as a new class. The semVer of the new class will be set automatically.
      Specified by:
      commit in interface Builder<T extends Builder<T>>
      Returns:
      this Builder.

    • commit

      @Contract("null -> fail; _ -> this") public T commit(io.github.chrimle.semver.SemVer semVer)
      Commits the currently uncommitted changes as a new class. The semVer of the new class will be set to the given semVer.
      Specified by:
      commit in interface Builder<T extends Builder<T>>
      Parameters:
      semVer - for the new class.
      Returns:
      this Builder.

    • determineSemVerChange

      protected io.github.chrimle.semver.Change determineSemVerChange()
      Determines the Change for the currently uncommitted changes.
      Returns:
      the Change.

    • self

      protected abstract T self()
      Returns this as AbstractBuilder.
      Returns:
      this.

    • validateAdditionalPredicates

      protected void validateAdditionalPredicates()
      Validates additional Predicates for determining the validity of the currently uncommitted class.

    • generateFileContent

      protected abstract String generateFileContent(io.github.chrimle.semver.SemVer semVer)
      Generates the complete file contents for a .java file for the currently uncommitted class.
      Parameters:
      semVer - for the new class.
      Returns:
      the file contents as a String.

    • generateClassFile

      protected void generateClassFile(io.github.chrimle.semver.SemVer semVer)
      Generates a .java class file for the currently uncommitted class.
      Parameters:
      semVer - for the new class.

    • resolveFullyQualifiedClassName

      protected String resolveFullyQualifiedClassName(io.github.chrimle.semver.SemVer semVer)
      Resolves the Fully Qualified Class Name (FQCN) for the currently uncommitted class.

      Example: module.sub_module.ExampleClass or AnotherExampleClass.

      Parameters:
      semVer - for the new class.
      Returns:
      the FQCN.

    • resolveEffectivePackageName

      protected String resolveEffectivePackageName(io.github.chrimle.semver.SemVer semVer)
      Resolves the effective package name for the currently uncommitted class.
      Parameters:
      semVer - for the class.
      Returns:
      the effective package name.

    • resolveEffectiveClassName

      protected String resolveEffectiveClassName(io.github.chrimle.semver.SemVer semVer)
      Resolves the effective class name for the currently uncommitted class.
      Parameters:
      semVer - for the class.
      Returns:
      the effective class name.