Index (sageactive4j-gradle-plugin 0.1.0 API)

A

apply(Project) - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jPlugin
artifactId() - Method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework: The sageactive4j artifact the generated example compiles against.

content - Variable in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder.GeneratedFile
Coordinate(String, String, String) - Constructor for class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector.Coordinate

declaresArtifact(Collection<FrameworkDetector.Coordinate>, Framework) - Static method in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector: Whether the project already declares framework's sageactive4j artifact.
detect(Collection<FrameworkDetector.Coordinate>) - Static method in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector

filesFor(Framework, Path, Path, String) - Static method in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder: The files framework gets, rendered.
framework - Variable in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector.Detection
Framework - Enum Class in io.github.josemodi97.sageactive4j.scaffold: The project types the init goal / sageactive4jInit task can scaffold for, each with the sageactive4j artifact its example needs.
FrameworkDetector - Class in io.github.josemodi97.sageactive4j.scaffold: Guesses which Framework a project uses from the coordinates it declares.
FrameworkDetector.Coordinate - Class in io.github.josemodi97.sageactive4j.scaffold: A declared group:artifact:version; the version may be null.
FrameworkDetector.Detection - Class in io.github.josemodi97.sageactive4j.scaffold
fromId(String) - Static method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework

getDeclaredDependencies() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask: group:name[:version] of what the project declares; set by the plugin.
getForce() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask: Overwrite files that already exist.
getFramework() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask: auto (default), plain, servlet (javax.servlet), jakarta, spring-boot2 or spring-boot3.
getJavaSourceDirectory() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask: Where the example class is written (under a sageactive4j package).
getResourceDirectory() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask: Where sageactive4j.properties is written (Spring Boot only).
GROUP_ID - Static variable in enum class io.github.josemodi97.sageactive4j.scaffold.Framework

id() - Method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework: The value users pass on the command line, e.g.
info(String) - Method in interface io.github.josemodi97.sageactive4j.scaffold.Scaffolder.Log
io.github.josemodi97.sageactive4j.gradle - package io.github.josemodi97.sageactive4j.gradle
io.github.josemodi97.sageactive4j.scaffold - package io.github.josemodi97.sageactive4j.scaffold
is(String, String) - Method in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector.Coordinate
isSpringBoot() - Method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework

JAKARTA - Enum constant in enum class io.github.josemodi97.sageactive4j.scaffold.Framework

nextSteps(Framework, String, boolean) - Static method in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder: What the user still has to do, one line per step.

path - Variable in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder.GeneratedFile
PLAIN - Enum constant in enum class io.github.josemodi97.sageactive4j.scaffold.Framework
PROPERTIES_FILE - Static variable in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder

reason - Variable in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector.Detection
run() - Method in class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask

SageActive4jInitTask - Class in io.github.josemodi97.sageactive4j.gradle: Scaffolds a working Sage Active example for the project's framework.
SageActive4jInitTask(ProjectLayout) - Constructor for class io.github.josemodi97.sageactive4j.gradle.SageActive4jInitTask
SageActive4jPlugin - Class in io.github.josemodi97.sageactive4j.gradle: Registers sageactive4jInit:
SageActive4jPlugin() - Constructor for class io.github.josemodi97.sageactive4j.gradle.SageActive4jPlugin
Scaffolder - Class in io.github.josemodi97.sageactive4j.scaffold: Writes the example files for a Framework.
Scaffolder.GeneratedFile - Class in io.github.josemodi97.sageactive4j.scaffold
Scaffolder.Log - Interface in io.github.josemodi97.sageactive4j.scaffold: Where the plugin's log output goes.
SERVLET - Enum constant in enum class io.github.josemodi97.sageactive4j.scaffold.Framework
SPRING_BOOT2 - Enum constant in enum class io.github.josemodi97.sageactive4j.scaffold.Framework
SPRING_BOOT3 - Enum constant in enum class io.github.josemodi97.sageactive4j.scaffold.Framework
supportedIds() - Static method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework

toString() - Method in class io.github.josemodi97.sageactive4j.scaffold.FrameworkDetector.Coordinate

valueOf(String) - Static method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.josemodi97.sageactive4j.scaffold.Framework: Returns an array containing the constants of this enum class, in the order they are declared.

write(List<Scaffolder.GeneratedFile>, boolean, Scaffolder.Log) - Static method in class io.github.josemodi97.sageactive4j.scaffold.Scaffolder: Writes files, skipping (and logging) any that exist unless force is set.