Freefair Gradle Plugins

https://docs.freefair.io/gradle-plugins/current/
Admin
Freefair Gradle Plugins is a comprehensive collection of Gradle plugins providing functionality for...
Tokens:107,811
Snippets:1,461
Trust Score:6.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Start MkDocs development server

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Gradle command to start the MkDocs development server using the io.freefair.mkdocs plugin.

```bash
./gradlew mkdocsServe
```

--------------------------------

### Apply io.freefair.mkdocs plugin (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Groovy DSL example for applying the io.freefair.mkdocs plugin. Requires MkDocs to be installed on the system.

```groovy
plugins {
    id "io.freefair.mkdocs" version "9.8.0"
}
```

--------------------------------

### Apply io.freefair.mkdocs plugin (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL example for applying the io.freefair.mkdocs plugin. Requires MkDocs to be installed on the system.

```kotlin
plugins {
    id("io.freefair.mkdocs") version "9.8.0"
}
```

--------------------------------

### Example SCSS file (src/main/resources/styles/main.scss)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Example SCSS file demonstrating variables, nesting, and color functions. Place in src/main/resources/ for Java projects.

```scss
$primary: #3366cc;

body {
  font-family: system-ui, sans-serif;

  a {
    color: $primary;

    &:hover {
      color: darken($primary, 15%);
    }
  }
}
```

--------------------------------

### getStartServer

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/GwtDevModeOptions.html

Returns a Property<Boolean> that starts a servlet container serving the directory specified by the -war flag. Defaults to ON.

```APIDOC
## getStartServer()

### Description
Starts a servlet container serving the directory specified by the -war flag. Defaults to ON.

### Method
Property<Boolean> getStartServer()

### Returns
Property<Boolean> - A property indicating whether to start the servlet container.
```

--------------------------------

### Configure Compile-Time Weaving (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Setup for compile-time weaving using the io.freefair.aspectj plugin.

```kotlin
plugins {
    id("io.freefair.aspectj") version "9.8.0"
}

java {
    toolchain {
        languageVersion.set(JavaLanguageVersion.of(17))
    }
}

dependencies {
    implementation("org.aspectj:aspectjrt:1.9.25.1")
}
```

--------------------------------

### Apply io.freefair.maven-plugin plugin (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Groovy DSL example for applying the io.freefair.maven-plugin plugin and adding required Maven dependencies.

```groovy
plugins {
    id "io.freefair.maven-plugin" version "9.8.0"
}

dependencies {
    implementation "org.apache.maven:maven-plugin-api:3.9.9"
    implementation "org.apache.maven.plugin-tools:maven-plugin-annotations:3.16.0"
}
```

--------------------------------

### Apply io.freefair.maven-plugin plugin (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL example for applying the io.freefair.maven-plugin plugin and adding required Maven dependencies.

```kotlin
plugins {
    id("io.freefair.maven-plugin") version "9.8.0"
}

dependencies {
    implementation("org.apache.maven:maven-plugin-api:3.9.9")
    implementation("org.apache.maven.plugin-tools:maven-plugin-annotations:3.16.0")
}
```

--------------------------------

### Configure Compile-Time Weaving (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Setup for compile-time weaving using the io.freefair.aspectj plugin.

```groovy
plugins {
    id "io.freefair.aspectj" version "9.8.0"
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

dependencies {
    implementation "org.aspectj:aspectjrt:1.9.25.1"
}
```

--------------------------------

### Configure Post-Compile Weaving (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Setup for post-compile weaving using the io.freefair.aspectj.post-compile-weaving plugin.

```groovy
plugins {
    id "java"
    id "io.freefair.aspectj.post-compile-weaving" version "9.8.0"
}

java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

dependencies {
    implementation "org.aspectj:aspectjrt:1.9.25.1"
}
```

--------------------------------

### Configure Post-Compile Weaving (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Setup for post-compile weaving using the io.freefair.aspectj.post-compile-weaving plugin.

```kotlin
plugins {
    java
    id("io.freefair.aspectj.post-compile-weaving") version "9.8.0"
}

java {
    toolchain {
        languageVersion.set(JavaLanguageVersion.of(17))
    }
}

dependencies {
    implementation("org.aspectj:aspectjrt:1.9.25.1")
}
```

--------------------------------

### Use commonsCompress.arTree in Kotlin

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Example of using the commonsCompress extension in a Sync task to include files from an ar archive.

```kotlin
tasks.register<Sync>("example") {
    from(commonsCompress.arTree(file("foo.ar")))
}
```

--------------------------------

### Use commonsCompress.arTree in Groovy

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Example of using the commonsCompress extension in a Sync task to include files from an ar archive.

```groovy
task example(type: Sync) {
    from commonsCompress.arTree(file("foo.ar"))
}
```

--------------------------------

### Add optional dependency with io.freefair.maven-optional (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL example for adding a dependency to the optional configuration provided by the io.freefair.maven-optional plugin.

```kotlin
dependencies {
    optional("com.example:foo-bar:1.0.0")
}
```

--------------------------------

### Add optional dependency with io.freefair.maven-optional (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Groovy DSL example for adding a dependency to the optional configuration provided by the io.freefair.maven-optional plugin.

```groovy
dependencies {
    optional "com.example:foo-bar:1.0.0"
}
```

--------------------------------

### Build Project with Gradle

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Standard command to build the project.

```bash
./gradlew build
```

--------------------------------

### Initialize new MkDocs project

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Gradle command to initialize a new MkDocs project using the io.freefair.mkdocs plugin.

```bash
./gradlew mkdocsNew
```

--------------------------------

### getForce()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/tasks/MkDocsGhDeploy.html

Gets the flag indicating whether to force the push to the repository.

```APIDOC
## getForce()

### Description
Gets the flag indicating whether to force the push to the repository.

### Method
`public abstract Property<Boolean> getForce()`

### Annotations
- @Optional
- @Input

### Returns
- **Property<Boolean>** - The force push flag property.

```

--------------------------------

### getCompileClasspath(Task) - AjcAction

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Static method to get the compile classpath for a task.

```APIDOC
## getCompileClasspath(Task)

### Description
Static method to get the compile classpath for a task.

### Method
GET

### Endpoint
io.freefair.gradle.plugins.aspectj.AjcAction#getCompileClasspath(Task)

### Parameters
#### Path Parameters
- **task** (Task) - Required - The task for which to get the compile classpath.

### Response
#### Success Response
- **compileClasspath** (FileCollection) - The compile classpath.

#### Response Example
```
{
  "compileClasspath": []
}
```
```

--------------------------------

### getMessage()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/tasks/MkDocsGhDeploy.html

Gets the commit message to use when committing to the GitHub Pages remote branch.

```APIDOC
## getMessage()

### Description
Gets the commit message to use when committing to the GitHub Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions.

### Method
`public abstract Property<String> getMessage()`

### Annotations
- @Optional
- @Input

### Returns
- **Property<String>** - The commit message property.

```

--------------------------------

### Build MkDocs documentation

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Gradle command to build the MkDocs documentation using the io.freefair.mkdocs plugin.

```bash
./gradlew mkdocs
```

--------------------------------

### ProjectContext(File rootDir, File inputDir, File outputDir, Map<String,Object> configurationValues, String sourceSet)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/codegenerator/api/ProjectContext.html

Constructor that initializes a ProjectContext with the specified directories, configuration values, and source set.

```APIDOC
## ProjectContext(File rootDir, File inputDir, File outputDir, Map<String,Object> configurationValues, String sourceSet)

### Description
Creates a new ProjectContext instance with the given root, input, and output directories, configuration values, and source set.

### Parameters
- **rootDir** (File) - Required - The root directory of the project.
- **inputDir** (File) - Required - The input directory for source files.
- **outputDir** (File) - Required - The output directory for generated files.
- **configurationValues** (Map<String,Object>) - Required - A map of configuration values.
- **sourceSet** (String) - Required - The source set name.

```

--------------------------------

### Apply OkHttp Plugin

Source: https://docs.freefair.io/gradle-plugins/current/reference

Apply the OkHttp plugin to a project.

```groovy
plugins {
    id "io.freefair.okhttp"
}
```

```kotlin
plugins {
    id("io.freefair.okhttp")
}
```

--------------------------------

### Use Lombok Annotations in Java

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Example of using @Data and @Slf4j annotations in a Java class.

```java
import lombok.Data;
import lombok.extern.slf4j.Slf4j;

@Data
@Slf4j
public class User {
    private String name;
    private String email;
}
```

--------------------------------

### getStartupUrl

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/GwtDevModeOptions.html

Returns a Property<String> that automatically launches the specified URL.

```APIDOC
## getStartupUrl()

### Description
Automatically launches the specified URL.

### Method
Property<String> getStartupUrl()

### Returns
Property<String> - A property for the startup URL.
```

--------------------------------

### getModule()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/CommonGwtToolOptions.html

Returns a ListProperty<String> for specifying the GWT modules that the code server should compile. Example: com.example.MyApp.

```APIDOC
## getModule()

### Description
Returns a ListProperty<String> for specifying the GWT modules that the code server should compile. Example: com.example.MyApp.

### Method
GET

### Endpoint
CommonGwtToolOptions#getModule()

### Parameters
None

### Returns
- **ListProperty<String>** - The module list property.
```

--------------------------------

### getIgnoreVersion()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/tasks/MkDocsGhDeploy.html

Gets the flag indicating whether to ignore the check that the build is not being deployed with an older version of MkDocs.

```APIDOC
## getIgnoreVersion()

### Description
Gets the flag indicating whether to ignore the check that the build is not being deployed with an older version of MkDocs.

### Method
`public abstract Property<Boolean> getIgnoreVersion()`

### Annotations
- @Optional
- @Input

### Returns
- **Property<Boolean>** - The ignore version flag property.

```

--------------------------------

### getLauncherDir()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/GwtCodeServerOptions.html

Returns a DirectoryProperty that specifies an output directory where files for launching Super Dev Mode will be written. Optional.

```APIDOC
## getLauncherDir()

### Description
An output directory where files for launching Super Dev Mode will be written. Optional.

### Method
DirectoryProperty getLauncherDir()

### Annotations
@Optional @OutputDirectory

### Returns
DirectoryProperty - A property representing the output directory for launcher files.
```

--------------------------------

### into Method

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Sets the destination path for the overlay.

```APIDOC
## into(Object destPath)

### Description
Sets the destination path for the overlay contents.

### Parameters
- **destPath** (Object) - Required - The destination path.

```

--------------------------------

### void apply(Project project)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/MkDocsPlugin.html

Applies the MkDocs plugin to a Gradle project, registering tasks for building, serving, and packaging documentation.

```APIDOC
## `void apply(Project project)`

### Description
Applies the plugin to a Gradle project. This registers tasks for building, serving, and packaging MkDocs-based documentation: `mkdocs`, `mkdocsServe`, `mkdocsNew`, `mkdocsZip`, and `mkdocsTar`. Requires MkDocs to be installed and available on the system PATH.

### Method
`void apply(Project project)`

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

### Returns
- **void** - This method returns nothing.

### Specified By
- `apply` in interface `Plugin<Project>`
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.okhttp.OkHttpPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the OkHttpPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the OkHttpPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### Configure OkHttp Extension

Source: https://docs.freefair.io/gradle-plugins/current/reference

Set the logging level for the OkHttpClient instance.

```groovy
okHttp {
    loggingLevel = okhttp3.logging.HttpLoggingInterceptor.Level.BASIC
}
```

```kotlin
okHttp {
    loggingLevel = okhttp3.logging.HttpLoggingInterceptor.Level.BASIC
}
```

--------------------------------

### execute(Project, String...)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/util/GitUtil.html

Executes a Git command and returns the output as a Gradle provider.

```APIDOC
## execute(Project, String...)

### Description
Executes a Git command and returns the output as a Gradle provider.

### Method
`public static Provider<String> execute(Project project, String... command)`

### Parameters
- `project` (Project) - Required - The Gradle project.
- `command` (String...) - Required - The Git command and its arguments.

### Returns
- `Provider<String>` - A provider for the command output.
```

--------------------------------

### getOptions()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectjCompile.html

Returns the compile options.

```APIDOC
## getOptions()

### Description
Returns the compile options.

### Method
Getter

### Signature
`public CompileOptions getOptions()`

### Returns
- **CompileOptions** - The compile options.

```

--------------------------------

### read(byte[] b, int off, int len)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/compress/internal/SevenZipArchiveInputStream.html

Reads up to len bytes of data from the input stream into an array of bytes starting at offset off.

```APIDOC
## Method: read(byte[] b, int off, int len)

### Description
Reads up to len bytes of data from the input stream into an array of bytes starting at offset off.

### Signature
public int read(byte[] b, int off, int len) throws IOException

### Parameters
- **b** (byte[]) - Required - The buffer into which the data is read.
- **off** (int) - Required - The start offset in the destination array b.
- **len** (int) - Required - The maximum number of bytes read.

### Returns
- **int** - The total number of bytes read into the buffer, or -1 if there is no more data.

### Throws
- **IOException** - If an I/O error occurs.

### Example
```java
byte[] buffer = new byte[1024];
int bytesRead = inputStream.read(buffer, 0, 1024);
```
```

--------------------------------

### Configure ValidateMavenPom task (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL example for registering a ValidateMavenPom task to validate a POM file for Maven Central requirements.

```kotlin
tasks.register<io.freefair.gradle.plugins.maven.central.ValidateMavenPom>("validateMyPom") {
    pomFile = file("path/to/my/pom.xml")
    ignoreFailures = false
}
```

--------------------------------

### getForkOptions()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectJCompileOptions.html

Returns the options for running the compiler in a child process.

```APIDOC
## getForkOptions()

### Description
Returns the options for running the compiler in a child process.

### Method
getForkOptions

### Signature
public AjcForkOptions getForkOptions()

### Returns
- **AjcForkOptions** - The fork options.
```

--------------------------------

### Configure ValidateMavenPom task (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Groovy DSL example for registering a ValidateMavenPom task to validate a POM file for Maven Central requirements.

```groovy
task validateMyPom(type: io.freefair.gradle.plugins.maven.central.ValidateMavenPom) {
    pomFile = file("path/to/my/pom.xml")
    ignoreFailures = false
}
```

--------------------------------

### write()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/builder/gradle/GradleConfigurationBuilder.html

Writes the Gradle configuration to the default file.

```APIDOC
## Method: write()

### Description
Writes the Gradle configuration to the default file.

### Signature
`public void write()`

### Parameters
None.

### Returns
void.
```

--------------------------------

### getRepository(String slug)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/github/internal/GithubService.html

Default method to get a repository by its slug. The slug is parsed to extract owner and repo, then delegates to the parameterized getRepository method.

```APIDOC
## getRepository(String slug)

### Description
Default method to get a repository by its slug. The slug is parsed to extract owner and repo, then delegates to the parameterized getRepository method.

### Method
GET

### Endpoint
repos/{owner}/{repo}

### Parameters
#### Path Parameters
- **owner** (String) - Required - The repository owner (extracted from slug).
- **repo** (String) - Required - The repository name (extracted from slug).

### Response
#### Success Response (200)
- **Repo** - The repository information.

### Response Example
```json
{
  "id": 1,
  "name": "repo",
  "full_name": "owner/repo"
}
```
```

--------------------------------

### Apply io.freefair.okhttp plugin (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Applies the OkHttp plugin in a Groovy build script. The plugin provides an OkHttpClient instance for use by other tasks and plugins.

```groovy
plugins {
    id "io.freefair.okhttp"
}
```

--------------------------------

### Configure mjml extension (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Configures the mjml extension with validation mode, minification, beautification, and options for minify and juice. The plugin installs MJML via npm and requires Node.js on the system PATH.

```groovy
mjml {
    validationMode = ValidationMode.strict
    minify = true
    beautify = false
    minifyOptions = "{\"minifyCSS\": true, \"removeEmptyAttributes\": false}"
    juiceOptions = "{\"preserveImportant\": true}"
    juicePreserveTags = "{\"myTag\": { \"start\": \"<#\", \"end\": \"</#\" }}"
}
```

--------------------------------

### Configure okHttp extension (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Configures the okHttp extension to set the logging level to BASIC.

```groovy
okHttp {
    loggingLevel = okhttp3.logging.HttpLoggingInterceptor.Level.BASIC
}
```

--------------------------------

### config(OutputStream, List<String>)

Source: https://docs.freefair.io/gradle-plugins/current/api/lombok/launch/LombokApi.html

Configures Lombok using the provided output stream and a list of string arguments.

```APIDOC
## config(OutputStream, List<String>)

### Description
Configures Lombok using the provided output stream and a list of string arguments.

### Method
config

### Signature
public void config(OutputStream outputStream, List<String> args)

### Parameters
- **outputStream** (OutputStream) - Required - The output stream for configuration output.
- **args** (List<String>) - Required - The list of string arguments for configuration.

### Return Type
void
```

--------------------------------

### Configure JacocoDump task (Groovy DSL)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Example of configuring a JacocoDump task to connect to a remote JaCoCo agent via TCP and download execution data. Sets address, port, retryCount, dump, reset, destfile, and append.

```groovy
task dump(type: io.freefair.gradle.plugins.jacoco.tasks.JacocoDump) {
    address = "localhost"
    port = 6300
    retryCount = 10
    dump = true
    reset = false
    destfile = file("build/dump.exec")
    append = true
}
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.compress.SevenZipPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the SevenZipPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the SevenZipPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### MkDocsGhDeploy()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/tasks/MkDocsGhDeploy.html

Constructor for the MkDocsGhDeploy task.

```APIDOC
## MkDocsGhDeploy()

### Description
Creates a new instance of the MkDocsGhDeploy task.

### Constructor
`public MkDocsGhDeploy()`

```

--------------------------------

### Create 7z archive with SevenZip task (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL equivalent for creating a 7z archive with the SevenZip task.

```Kotlin
tasks.register<io.freefair.gradle.plugins.compress.tasks.SevenZip>("packageSevenZipArchive") {
    archiveFileName = "my-distribution.7z"
    destinationDirectory = file("$buildDir/dist")

    from("$buildDir/toArchive")

    contentCompression = org.apache.commons.compress.archivers.sevenz.SevenZMethod.LZMA2
}
```

--------------------------------

### provided()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Marks the overlay as provided.

```APIDOC
## provided()

### Description
Marks the overlay as provided, meaning its dependencies are not included in the final WAR.

```

--------------------------------

### Apply io.freefair.okhttp plugin (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Applies the OkHttp plugin in a Kotlin build script. The plugin provides an OkHttpClient instance for use by other tasks and plugins.

```kotlin
plugins {
    id("io.freefair.okhttp")
}
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.github.GithubPackageRegistryMavenPublishPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the GithubPackageRegistryMavenPublishPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the GithubPackageRegistryMavenPublishPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### getAllFiles()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/codegenerator/api/ProjectContext.html

Returns a list of all ProjectFile objects in the context.

```APIDOC
## getAllFiles()

### Description
Returns a list of all ProjectFile objects in the context.

### Method
GET

### Endpoint
ProjectContext.getAllFiles()

### Response
- **List<ProjectFile>** - A list of all project files.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.war.WarOverlayPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the WarOverlayPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the WarOverlayPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.mkdocs.MkDocsPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the MkDocsPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the MkDocsPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### Delombok.getLauncher()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/lombok/tasks/Delombok.html

Returns the JavaLauncher used to invoke lombok.

```APIDOC
## Delombok.getLauncher()

### Description
Returns the JavaLauncher used to invoke lombok.

### Method
Property<JavaLauncher>

### Parameters
None

### Response
Property<JavaLauncher> - the JavaLauncher.
```

--------------------------------

### JakartaEE9LinkProvider()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/javadoc/linkproviders/JakartaEE9LinkProvider.html

Constructs a new JakartaEE9LinkProvider instance.

```APIDOC
## Constructor: JakartaEE9LinkProvider()

### Description
Creates a new instance of the JakartaEE9LinkProvider class.

### Signature
`public JakartaEE9LinkProvider()`

### Parameters
None.

### Returns
A new JakartaEE9LinkProvider object.
```

--------------------------------

### options(Action<CompileOptions>)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectjCompile.html

Configures the compile options.

```APIDOC
## options(Action<CompileOptions>)

### Description
Configures the compile options.

### Method
Configuration method

### Signature
`public void options(Action<CompileOptions> action)`

### Parameters
- **action** (Action<CompileOptions>) - Required - The action to configure the compile options.

```

--------------------------------

### JakartaEE8LinkProvider()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/javadoc/linkproviders/JakartaEE8LinkProvider.html

Constructs a new JakartaEE8LinkProvider instance.

```APIDOC
## Constructor: JakartaEE8LinkProvider()

### Description
Creates a new instance of the JakartaEE8LinkProvider class.

### Signature
`public JakartaEE8LinkProvider()`

### Parameters
None.

### Returns
A new JakartaEE8LinkProvider object.
```

--------------------------------

### getConfigFile() - MkDocsGhDeploy

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Provide a specific MkDocs config.

```APIDOC
## getConfigFile()

### Description
Provide a specific MkDocs config.

### Method
GET

### Endpoint
io.freefair.gradle.plugins.mkdocs.tasks.MkDocsGhDeploy#getConfigFile()

### Parameters
None

### Response
#### Success Response
- **configFile** (File) - The config file.

#### Response Example
```
{
  "configFile": "mkdocs.yml"
}
```
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.git.GitVersionPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the GitVersionPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the GitVersionPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### config(OutputStream, File...)

Source: https://docs.freefair.io/gradle-plugins/current/api/lombok/launch/LombokApi.html

Configures Lombok using the provided output stream and file paths.

```APIDOC
## config(OutputStream, File...)

### Description
Configures Lombok using the provided output stream and file paths.

### Method
config

### Signature
public void config(OutputStream outputStream, File... paths)

### Parameters
- **outputStream** (OutputStream) - Required - The output stream for configuration output.
- **paths** (File...) - Required - The file paths to configure.

### Return Type
void
```

--------------------------------

### Create Cpio archive with Cpio task (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Kotlin DSL equivalent for creating a cpio archive with the Cpio task.

```Kotlin
tasks.register<io.freefair.gradle.plugins.compress.tasks.Cpio>("packageCpioArchive") {
    archiveFileName = "my-distribution.cpio"
    destinationDirectory = file("$buildDir/dist")

    from("$buildDir/toArchive")

    format = org.apache.commons.compress.archivers.cpio.CpioConstants.FORMAT_NEW
    blockSize = 512
    encoding = "US-ASCII"
}
```

--------------------------------

### Apply io.freefair.settings.plugin-versions in settings.gradle

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Apply the plugin in settings.gradle to manage FreeFair plugin versions centrally.

```groovy
// settings.gradle
plugins {
    id "io.freefair.settings.plugin-versions" version "9.8.0"
}
```

--------------------------------

### Apply io.freefair.settings.plugin-versions in settings.gradle.kts

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Apply the plugin in settings.gradle.kts to manage FreeFair plugin versions centrally.

```kotlin
// settings.gradle.kts
plugins {
    id("io.freefair.settings.plugin-versions") version "9.8.0"
}
```

--------------------------------

### apply(Project project)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/sass/SassWarPlugin.html

Applies the plugin to a Gradle project. It applies SassWebjarsPlugin and WarPlugin, then registers a compileWebappSass task that compiles Sass/SCSS files from the webapp directory and includes the compiled CSS in the WAR file.

```APIDOC
## Method: apply(Project project)

### Description
Applies the SassWarPlugin to the given Gradle project. This method integrates Sass compilation with WAR projects by applying SassWebjarsPlugin and WarPlugin, and registering a compileWebappSass task.

### Signature
public void apply(Project project)

### Parameters
- **project** (Project) - Required - The Gradle project to which the plugin is applied.

### Returns
void

### Specified By
apply in interface Plugin<Project>
```

--------------------------------

### GZip()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/compress/tasks/GZip.html

Constructor for the GZip task. Creates a new GZip task instance.

```APIDOC
## GZip()

### Description
Constructor for the GZip task. Creates a new GZip task instance.

### Method
Constructor

### Signature
`public GZip()`

```

--------------------------------

### ApacheLinkProvider()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/javadoc/linkproviders/ApacheLinkProvider.html

Constructor for ApacheLinkProvider.

```APIDOC
## Constructor: ApacheLinkProvider()

### Description
Creates a new instance of ApacheLinkProvider.

### Signature
`public ApacheLinkProvider()`

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.github.GithubPomPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the GithubPomPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the GithubPomPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### getExtdirs()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectJCompileOptions.html

Returns the extdirs configuration file collection. Override location of VM's extension directories for purposes of evaluating types when compiling.

```APIDOC
## Method: getExtdirs()

### Description
Returns the extdirs configuration file collection. Override location of VM's extension directories for purposes of evaluating types when compiling.

### Returns
- **ConfigurableFileCollection** - The extdirs file collection.
```

--------------------------------

### provided Methods

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Sets the provided flag for the overlay.

```APIDOC
## provided()

### Description
Marks this overlay as provided.

## provided(boolean provided)

### Description
Sets whether this overlay is provided.

### Parameters
- **provided** (boolean) - Required - The provided flag.

```

--------------------------------

### MkDocsBuild

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/mkdocs/tasks/MkDocsBuild.html

Build the MkDocs documentation. This task is cacheable and extends the MkDocs task.

```APIDOC
## MkDocsBuild

### Description
Build the MkDocs documentation. This task is cacheable and extends the MkDocs task.

### Class
`io.freefair.gradle.plugins.mkdocs.tasks.MkDocsBuild`

### Constructor
- `MkDocsBuild()` - Creates a new instance of the task.

### Properties

#### getConfigFile()
- **Type**: `RegularFileProperty`
- **Annotations**: `@Optional`, `@InputFile`, `@PathSensitive(RELATIVE)`
- **Description**: Provide a specific MkDocs config.

#### getStrict()
- **Type**: `Property<Boolean>`
- **Annotations**: `@Optional`, `@Input`
- **Description**: Enable strict mode. This will cause MkDocs to abort the build on any warnings.

#### getTheme()
- **Type**: `Property<String>`
- **Annotations**: `@Optional`, `@Input`
- **Description**: The theme to use when building your documentation.

#### getThemeDir()
- **Type**: `DirectoryProperty`
- **Annotations**: `@Optional`, `@InputDirectory`, `@IgnoreEmptyDirectories`, `@PathSensitive(RELATIVE)`
- **Description**: The theme directory to use when building your documentation.

#### getSiteDir()
- **Type**: `DirectoryProperty`
- **Annotations**: `@OutputDirectory`
- **Description**: The directory to output the result of the documentation build.

### Inherited Methods
- From `MkDocs`: `exec`, `getCommand`, `getExecOperations`, `getQuiet`, `getVerbose`
- From `DefaultTask`: standard Gradle task methods (e.g., `dependsOn`, `doFirst`, `doLast`, `getDescription`, `getGroup`, `getName`, `getProject`, `getOutputs`, `getInputs`, etc.)

```

--------------------------------

### from(Object object, Closure configureClosure)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Sets the source of the overlay with a configuration closure.

```APIDOC
## from(Object object, Closure configureClosure)

### Description
Sets the source of the overlay and provides a closure for configuring the dependency resolution.

### Parameters
- **object** (Object) - Required - The source of the overlay.
- **configureClosure** (Closure) - Required - Closure passed to DependencyHandler.create(Object, Closure) when source is resolved as a dependency.

```

--------------------------------

### DownloadFile()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/okhttp/tasks/DownloadFile.html

Constructor for the DownloadFile task class.

```APIDOC
## DownloadFile()

### Description
Constructor for the DownloadFile task class.

### Method
Constructor

### Signature
public DownloadFile()

```

--------------------------------

### getForkOptions()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectJCompileOptions.html

Returns the fork options for running the compiler in a child process.

```APIDOC
## Method: getForkOptions()

### Description
Returns the fork options for running the compiler in a child process.

### Returns
- **AjcForkOptions** - The fork options.
```

--------------------------------

### getProject()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/MavenPublishBasePlugin.html

Returns the project.

```APIDOC
## getProject()

### Description
Returns the project.

### Method
getProject

### Signature
`public Project getProject()`

### Returns
- **Project** - The project.

```

--------------------------------

### Apply io.freefair.lombok plugin using legacy plugin application (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Configures the buildscript classpath and applies the plugin in Groovy. Requires the Gradle Plugin Portal repository.

```groovy
buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "io.freefair.gradle:lombok-plugin:9.8.0"
  }
}

apply plugin: "io.freefair.lombok"
```

--------------------------------

### getServer

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/GwtDevModeOptions.html

Returns a Property<String> that specifies a different embedded web server to run. The server must implement ServletContainerLauncher.

```APIDOC
## getServer()

### Description
Specify a different embedded web server to run (must implement ServletContainerLauncher).

### Method
Property<String> getServer()

### Returns
Property<String> - A property for the server class name.
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.javadoc.JavadocUtf8Plugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the JavadocUtf8Plugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the JavadocUtf8Plugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.plantuml.PlantumlPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the PlantumlPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the PlantumlPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.MavenPublishBasePlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the MavenPublishBasePlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the MavenPublishBasePlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.war.WarArchiveClassesPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the WarArchiveClassesPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the WarArchiveClassesPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### sevenZipTree

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/compress/CompressFileOperations.html

Creates a FileTree for a 7z archive file, with optional password.

```APIDOC
## sevenZipTree

### Description
Creates a FileTree for a 7z archive file, with optional password.

### Method
sevenZipTree

### Signatures
- FileTree sevenZipTree(Object sevenZipFile)
- FileTree sevenZipTree(Object sevenZipFile, char[] password)

### Parameters
- **sevenZipFile** (Object) - Required - The 7z archive file.
- **password** (char[]) - Optional - The password for encrypted archives.

### Returns
FileTree - A FileTree representation of the archive.
```

--------------------------------

### GitVersionPlugin()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/git/GitVersionPlugin.html

Constructor for the GitVersionPlugin class.

```APIDOC
## GitVersionPlugin()

### Description
Constructor for the GitVersionPlugin class.

### Constructor
GitVersionPlugin()
```

--------------------------------

### WarOverlay(String name, War warTask)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Constructor for creating a WarOverlay instance with a name and a War task.

```APIDOC
## WarOverlay(String name, War warTask)

### Description
Creates a new WarOverlay with the given name and War task.

### Parameters
- **name** (String) - Required - The name of the overlay.
- **warTask** (War) - Required - The War task to which this overlay applies.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.github.GithubBasePlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the GithubBasePlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the GithubBasePlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### getLauncher()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectjCompile.html

Returns the Java launcher property for the task.

```APIDOC
## getLauncher()

### Description
Returns the Java launcher property for the task.

### Method
Getter

### Signature
`@Optional public abstract Property<JavaLauncher> getLauncher()`

### Returns
- **Property<JavaLauncher>** - The Java launcher property.

```

--------------------------------

### Configure Aspectpath Dependencies (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Declare additional advices for the -aspectpath argument using Groovy DSL.

```Groovy
dependencies {
    aspect project(":my-aspect")
    testAspect "com.example.foo:bar-aspect:1.0.0"
}
```

--------------------------------

### Run compileWebappSass task

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Command to compile Sass for WAR projects.

```bash
./gradlew compileWebappSass
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.war.WarPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the WarPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the WarPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### getSourceroots()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/aspectj/AspectJCompileOptions.html

Returns the sourceroots configuration, which finds and builds all .java or .aj source files under any directory listed.

```APIDOC
## getSourceroots()

### Description
Returns the sourceroots configuration, which finds and builds all .java or .aj source files under any directory listed in DirPaths.

### Method
getSourceroots

### Signature
public ConfigurableFileCollection getSourceroots()

### Returns
- **ConfigurableFileCollection** - The sourceroots file collection.
```

--------------------------------

### getSoftwareComponent()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/MavenPublishBasePlugin.html

Returns the software component.

```APIDOC
## getSoftwareComponent()

### Description
Returns the software component.

### Method
getSoftwareComponent

### Signature
`public SoftwareComponent getSoftwareComponent()`

### Returns
- **SoftwareComponent** - The software component.

```

--------------------------------

### getDeploy

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/gwt/GwtDevModeOptions.html

Returns a DirectoryProperty that specifies the directory into which deployable but not servable output files will be written. Defaults to 'WEB-INF/deploy' under the -war directory/jar.

```APIDOC
## getDeploy()

### Description
The directory into which deployable but not servable output files will be written. Defaults to 'WEB-INF/deploy' under the -war directory/jar, and may be the same as the -extra directory/jar.

### Method
DirectoryProperty getDeploy()

### Returns
DirectoryProperty - A directory property for the deploy directory.
```

--------------------------------

### getVerbose() - LombokConfig

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Returns whether to display more information.

```APIDOC
## getVerbose()

### Description
Returns whether to display more information.

### Method
GET

### Endpoint
io.freefair.gradle.plugins.lombok.tasks.LombokConfig#getVerbose()

### Parameters
None

### Response
- **verbose** (boolean) - True if verbose, false otherwise.
```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.javadoc.JavadocLinksPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the JavadocLinksPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the JavadocLinksPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### WarOverlay Constructor

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Creates a new WarOverlay instance with the specified name and War task.

```APIDOC
## WarOverlay(String name, War warTask)

### Description
Constructs a WarOverlay with the given name and associated War task.

### Parameters
- **name** (String) - Required - The name of the overlay.
- **warTask** (War) - Required - The War task associated with this overlay.

```

--------------------------------

### apply(Project) - Method in io.freefair.gradle.plugins.maven.javadoc.JavadocsPlugin

Source: https://docs.freefair.io/gradle-plugins/current/api/index-all.html

Applies the JavadocsPlugin to a Gradle project.

```APIDOC
## apply(Project)

### Description
Applies the JavadocsPlugin to a Gradle project.

### Method
apply

### Parameters
- **project** (Project) - Required - The Gradle project to apply the plugin to.

```

--------------------------------

### apply(Project project)

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarArchiveClassesPlugin.html

Applies the plugin to the given project, adding the 'archiveClasses' extension property to War tasks.

```APIDOC
## apply(Project project)

### Description
Applies the plugin to the given project, adding the 'archiveClasses' extension property to War tasks.

### Method
apply

### Parameters
- **project** (Project) - Required - The project to apply the plugin to.

### Returns
void

### Specified by
`apply` in interface `Plugin<Project>`
```

--------------------------------

### MavenPublishBasePlugin()

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/MavenPublishBasePlugin.html

Constructor for MavenPublishBasePlugin.

```APIDOC
## MavenPublishBasePlugin()

### Description
Constructor for the MavenPublishBasePlugin class.

### Method
Constructor

### Signature
`public MavenPublishBasePlugin()`

```

--------------------------------

### Apply io.freefair.lombok plugin using legacy plugin application (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Configures the buildscript classpath and applies the plugin in Kotlin. Requires the Gradle Plugin Portal repository.

```kotlin
buildscript {
  repositories {
    maven {
      url = uri("https://plugins.gradle.org/m2/")
    }
  }
  dependencies {
    classpath("io.freefair.gradle:lombok-plugin:9.8.0")
  }
}

apply(plugin = "io.freefair.lombok")
```

--------------------------------

### getSource

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Returns the source of the overlay.

```APIDOC
## getSource()

### Description
Returns the source of the overlay. The source can be an AbstractArchiveTask, a Project with the war plugin, a File, or anything usable as a dependency.

### Returns
- **Object** - The source object.

```

--------------------------------

### from Methods

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Sets the source of the overlay from an object, optionally with a configuration closure.

```APIDOC
## from(Object object)

### Description
Sets the source of the overlay to the given object.

### Parameters
- **object** (Object) - Required - The source object.

## from(Object object, Closure configureClosure)

### Description
Sets the source of the overlay and applies a configuration closure.

### Parameters
- **object** (Object) - Required - The source object.
- **configureClosure** (Closure) - Required - The configuration closure.

```

--------------------------------

### Configure Aspectpath Dependencies (Kotlin)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Declare additional advices for the -aspectpath argument using Kotlin DSL.

```Kotlin
dependencies {
    aspect(project(":my-aspect"))
    testAspect("com.example.foo:bar-aspect:1.0.0")
}
```

--------------------------------

### Create 7z archive with SevenZip task (Groovy)

Source: https://docs.freefair.io/gradle-plugins/current/reference/#_aspectj_plugins

Configures a SevenZip task to create a 7z archive with LZMA2 content compression.

```Groovy
task packageSevenZipArchive(type: io.freefair.gradle.plugins.compress.tasks.SevenZip) {
    archiveFileName = "my-distribution.7z"
    destinationDirectory = file("$buildDir/dist")

    from "$buildDir/toArchive"

    contentCompression = org.apache.commons.compress.archivers.sevenz.SevenZMethod.LZMA2
}
```

--------------------------------

### include Methods

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/maven/war/WarOverlay.html

Configures patterns or specs for including files in the overlay.

```APIDOC
## include(Closure includeSpec)

### Description
Adds an include specification using a closure.

### Parameters
- **includeSpec** (Closure) - Required - The closure defining the include spec.

## include(Iterable<String> includes)

### Description
Adds a collection of include patterns.

### Parameters
- **includes** (Iterable<String>) - Required - The include patterns.

## include(String... includes)

### Description
Adds one or more include patterns.

### Parameters
- **includes** (String...) - Required - The include patterns.

## include(Spec<FileTreeElement> includeSpec)

### Description
Adds an include specification using a Spec.

### Parameters
- **includeSpec** (Spec<FileTreeElement>) - Required - The include spec.

```
Tokens:
Raw