### Setup Method

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

The setup method is annotated with @BeforeEach and is executed before each test.

```APIDOC
## setup

### Description
Initializes the test environment before each test case.

### Method
public void setup()

### Throws
IOException
```

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

### SCSS File Example

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

Example SCSS file content. Compiled CSS is automatically included in processed resources for Java projects.

```scss
$primary: #3366cc;

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

  a {
    color: $primary;

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

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

### Create Archive Tree from AR File in Groovy

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

Example of creating a file tree from an AR archive using the `commonsCompress.arTree` method within a `Sync` task.

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

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

### Create Archive Tree from AR File in Kotlin

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

Example of creating a file tree from an AR archive using the `commonsCompress.arTree` method within a `Sync` task using Kotlin DSL.

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

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

### Build Project with Gradle

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

Execute the standard Gradle build task.

```bash
./gradlew build
```

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

### Get License Information

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

Fetches license information for a repository. This method uses a GET request and accepts a URL to the license file.

```APIDOC
## getLicense
@GET retrofit2.Call<License> getLicense(@Url String url)
```

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

### GitVersionPlugin Constructor

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

Initializes a new instance of the GitVersionPlugin.

```APIDOC
## GitVersionPlugin()

### Description
Constructs a new GitVersionPlugin.

### Constructor
`GitVersionPlugin()`
```

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

### Get User Information

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

Retrieves information about a GitHub user. This method is annotated with @GET to specify the API endpoint for user data.

```java
@GET("users/{user}") retrofit2.Call<User> getUser(@Path("user") String user)
```

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

### WarOverlayPlugin Constructor

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

Initializes a new instance of the WarOverlayPlugin.

```APIDOC
## Constructor

### WarOverlayPlugin()

Initializes a new instance of the `WarOverlayPlugin` class.
```

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

### Get User Information

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

Retrieves detailed information about a specific GitHub user based on their username. This method utilizes a GET request to the GitHub API.

```APIDOC
## getUser
@GET("users/{user}") retrofit2.Call<User> getUser(@Path("user") String user)
```

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

### Manifest.File Constructors

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

Provides details on how to instantiate the Manifest.File class.

```APIDOC
## File Constructor

### Description
Creates a new `File` instance.

### Signature
`public File(String source_location)`

### Parameters
* `source_location` (String) - Required - The path of the manifest file relative to the root of the Git repository.

## File Constructor

### Description
Creates a new `File` instance.

### Signature
`public File()`
```

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

### Repo Constructor

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

Initializes a new instance of the Repo class.

```APIDOC
## Repo()

### Description
Constructs a new Repo object.

### Constructor
public Repo()
```

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

### Get Repository by Owner and Repo Name

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

Fetches repository details using the owner's username and the repository name. This method uses a GET request to the GitHub API.

```APIDOC
## getRepository
@GET("repos/{owner}/{repo}") retrofit2.Call<Repo> getRepository(@Path("owner") String owner, @Path("repo") String repo)
```

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

### Get License Information

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

Fetches license information for a repository using a provided URL. This method uses Retrofit's @GET annotation without explicit path parameters.

```java
@GET retrofit2.Call<License> getLicense(@Url String url)
```

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

### Create SevenZip Archive with Kotlin

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

Use this task to create '7z' archives. Configure the archive file name, destination directory, source files, and the content compression method.

```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
}
```

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

### Get Repository by Owner and Repo

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

Fetches a specific GitHub repository using the owner and repository name. This method uses Retrofit's @GET annotation to define the API endpoint.

```java
@GET("repos/{owner}/{repo}") retrofit2.Call<Repo> getRepository(@Path("owner") String owner, @Path("repo") String repo)
```

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

### Create SevenZip Archive with Groovy

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

Use this task to create '7z' archives. Configure the archive file name, destination directory, source files, and the content compression method.

```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
}
```

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

### File Creation Methods

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

Methods for creating files and directories within the test project.

```APIDOC
## createFile (fileName)

### Description
Creates a file with the specified name in the test project directory.

### Method
protected FileBuilder createFile(String fileName)

### Returns
A FileBuilder instance for the created file.
```

```APIDOC
## createFile (directory, fileName)

### Description
Creates a file with the specified name in the given directory within the test project.

### Method
protected FileBuilder createFile(String directory, String fileName)

### Returns
A FileBuilder instance for the created file.
```

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

### getSource()

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

Gets the source of the overlay.

```APIDOC
## Method getSource

### Description
Gets the source of the overlay.

### Signature
public Object getSource()

### Returns
(Object) - The source of the overlay. This can be an arbitrary AbstractArchiveTask, another Project with the 'war'-plugin applied, a File instance, or anything that can be used as a Dependency.
```

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

### getName()

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

Gets the name of the overlay.

```APIDOC
## Method getName

### Description
Gets the name of the overlay.

### Signature
public String getName()

### Returns
(String) - The name of the overlay.
```

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

### AbstractGeneratorTask.getGoalPrefix()

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

The goal prefix that will appear before the ":".

```APIDOC
## AbstractGeneratorTask.getGoalPrefix()

### Description
The goal prefix that will appear before the ":".

### Method
GET

### Endpoint
/maven/plugin/generator/goalPrefix
```

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

### License Constructor

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

Initializes a new instance of the License class.

```APIDOC
## License()

### Description
Initializes a new instance of the License class.

### Constructor
`License()`
```

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

### getConfigurationName()

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

Gets the configuration name of the overlay.

```APIDOC
## Method getConfigurationName

### Description
Gets the configuration name of the overlay.

### Signature
public String getConfigurationName()

### Returns
(String) - The configuration name.
```

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

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

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

Configures Lombok with the specified output stream and arguments.

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

### Description
Configures Lombok with the specified output stream and arguments.

### Method
`void config(OutputStream outputStream, List<String> args)`

### Parameters
#### Path Parameters
- **outputStream** (OutputStream) - Required - The output stream to use for configuration.
- **args** (List<String>) - Required - A list of arguments for configuration.
```

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

### Method: getSize

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

Gets the size of the file.

```APIDOC
## Method: getSize

### Description
Gets the size of the file.

### Implements
* `getSize` in interface `FileTreeElement`
```

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

### getWarTask()

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

Gets the War task associated with this overlay.

```APIDOC
## Method getWarTask

### Description
Gets the War task associated with this overlay.

### Signature
public War getWarTask()

### Returns
(War) - The associated War task.
```

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

### User Constructor

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

Initializes a new instance of the User class.

```APIDOC
## User()

### Description
Constructs a new User object.

### Constructor
`User()`
```

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

### getLauncherDir()

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

Retrieves the output directory for launching Super Dev Mode. Used in GwtCodeServerOptions.

```APIDOC
## getLauncherDir()

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

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A
```

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

### getExcludes()

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

Gets the set of exclude patterns for the overlay.

```APIDOC
## Method getExcludes

### Description
Gets the set of exclude patterns for the overlay.

### Signature
public Set<String> getExcludes()

### Returns
(Set<String>) - The set of exclude patterns.
```

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

### getIncludes()

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

Gets the set of include patterns for the overlay.

```APIDOC
## Method getIncludes

### Description
Gets the set of include patterns for the overlay.

### Signature
public Set<String> getIncludes()

### Returns
(Set<String>) - The set of include patterns.
```

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

### Create Cpio Archive with Kotlin

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

Use this task to create 'cpio' archives. Configure the archive file name, destination directory, source files, and cpio format specific options like block size and encoding.

```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"
}
```

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

### Method: getFile

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

Gets the file represented by this element.

```APIDOC
## Method: getFile

### Description
Gets the file represented by this element.

### Implements
* `getFile` in interface `FileTreeElement`
```

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

### into Method

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

Specifies the destination path for the overlay content.

```APIDOC
## into(Object destPath)

### Description
Sets the destination path within the WAR archive for the overlay content.

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

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

### JakartaEE9LinkProvider Constructor

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

Initializes a new instance of the JakartaEE9LinkProvider class.

```APIDOC
## JakartaEE9LinkProvider()

### Description
Constructs a new JakartaEE9LinkProvider.

### Constructor
`public JakartaEE9LinkProvider()`
```

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

### Method: getDisplayName

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

Gets a human-readable name for the resource.

```APIDOC
## Method: getDisplayName

### Description
Gets a human-readable name for the resource. This method is specified by the `Describable`, `Resource`, and `org.gradle.internal.resource.Resource` interfaces.

### Signature
`public String getDisplayName()`

### Returns
* **String** - A display name for the resource.
```

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

### getConfigureClosure()

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

Gets the configuration closure associated with the source dependency.

```APIDOC
## Method getConfigureClosure

### Description
Gets the configuration closure associated with the source dependency.

### Signature
public groovy.lang.Closure getConfigureClosure()

### Returns
(groovy.lang.Closure) - The configuration closure.
```

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

### WarOverlay Constructor

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

Initializes a new instance of the WarOverlay class.

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

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

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

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

### getWarCopySpec()

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

Gets the internal CopySpec used for the war overlay.

```APIDOC
## Method getWarCopySpec

### Description
Gets the internal CopySpec used for the war overlay.

### Signature
public org.gradle.api.internal.file.copy.CopySpecInternal getWarCopySpec()

### Returns
(org.gradle.api.internal.file.copy.CopySpecInternal) - The internal CopySpec.
```

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

### WarOverlay Constructor

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

Initializes a new instance of the WarOverlay class.

```APIDOC
## Constructor WarOverlay

### Description
Initializes a new instance of the WarOverlay class.

### Signature
public WarOverlay(String name, War warTask)

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

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

### JakartaEE8LinkProvider Constructor

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

Initializes a new instance of the JakartaEE8LinkProvider class.

```APIDOC
## JakartaEE8LinkProvider()

### Description
Constructs a new JakartaEE8LinkProvider.

### Constructor
`public JakartaEE8LinkProvider()`
```

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

### Method: getLastModified

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

Gets the last modified time of the file.

```APIDOC
## Method: getLastModified

### Description
Gets the last modified time of the file.

### Implements
* `getLastModified` in interface `FileTreeElement`
```

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

### Apply OkHttp Plugin

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

Apply the OkHttp plugin to your project. This plugin provides an OkHttpClient instance that can be used by other tasks and plugins.

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

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

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

### Method: getRelativePath

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

Gets the relative path of the file within the archive.

```APIDOC
## Method: getRelativePath

### Description
Gets the relative path of the file within the archive.

### Implements
* `getRelativePath` in interface `FileTreeElement`
```

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

### Method: getSchemePrefix

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

Abstract method to get the scheme prefix for the archiver.

```APIDOC
## Method: getSchemePrefix

### Description
Abstract method to retrieve the scheme prefix associated with this archiver (e.g., 'zip', 'tar'). Subclasses must implement this method.

### Signature
`protected abstract String getSchemePrefix()`

### Returns
* **String** - The scheme prefix.
```

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

### CleanLombokConfig Constructor

Source: https://docs.freefair.io/gradle-plugins/current/api/io/freefair/gradle/plugins/lombok/internal/CleanLombokConfig.html

Initializes a new instance of the CleanLombokConfig class.

```APIDOC
## CleanLombokConfig()

### Description
Constructs a new CleanLombokConfig object.

### Constructor
`CleanLombokConfig()`
```

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

### Detector Methods

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

Provides access to methods for getting and setting detector properties.

```APIDOC
## getName()

### Description
Gets the name of the detector.

### Method
`public String getName()`

### Returns
A String representing the detector's name.
```

```APIDOC
## getVersion()

### Description
Gets the version of the detector.

### Method
`public String getVersion()`

### Returns
A String representing the detector's version.
```

```APIDOC
## getUrl()

### Description
Gets the URL associated with the detector.

### Method
`public String getUrl()`

### Returns
A String representing the detector's URL.
```

```APIDOC
## setName(String name)

### Description
Sets the name of the detector.

### Method
`public void setName(String name)`

### Parameters
- **name** (String) - The name to set for the detector.
```

```APIDOC
## setVersion(String version)

### Description
Sets the version of the detector.

### Method
`public void setVersion(String version)`

### Parameters
- **version** (String) - The version to set for the detector.
```

```APIDOC
## setUrl(String url)

### Description
Sets the URL associated with the detector.

### Method
`public void setUrl(String url)`

### Parameters
- **url** (String) - The URL to set for the detector.
```

```APIDOC
## equals(Object o)

### Description
Indicates whether some other object is \"equal to\" this one.

### Method
`public boolean equals(Object o)`

### Parameters
- **o** (Object) - The reference object with which to compare.

### Returns
`true` if this object is the same as the obj argument; `false` otherwise.

### Overrides
`equals` in class `Object`
```

```APIDOC
## canEqual(Object other)

### Description
Indicates whether some other object is \"equal to\" this one.

### Method
`protected boolean canEqual(Object other)`

### Parameters
- **other** (Object) - The reference object with which to compare.
```

```APIDOC
## hashCode()

### Description
Returns a hash code value for the object.

### Method
`public int hashCode()`

### Returns
A hash code value for this object.

### Overrides
`hashCode` in class `Object`
```

```APIDOC
## toString()

### Description
Returns a string representation of the object.

### Method
`public String toString()`

### Returns
A string representation of the object.

### Overrides
`toString` in class `Object`
```

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

### ProjectContext Constructor

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

Initializes a new instance of the ProjectContext class.

```APIDOC
## Constructor ProjectContext

### Description
Initializes a new instance of the ProjectContext class.

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

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

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

### getContentCompression

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

Gets the property that defines the content compression method for SevenZip archives.

```APIDOC
## getContentCompression

### Description

Returns a property representing the compression method used for the content within the SevenZip archive. This allows for configuration of the compression algorithm.

### Method

`@Input public abstract Property<org.apache.commons.compress.archivers.sevenz.SevenZMethod> getContentCompression()`

### Returns

A `Property` object that can be configured with a `SevenZMethod` enum value.
```

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

### LzmaArchiver Constructor

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

Initializes a new instance of the LzmaArchiver class.

```APIDOC
## LzmaArchiver(File xzFile)

### Description
Initializes a new instance of the LzmaArchiver class.

### Parameters
#### Path Parameters
- **xzFile** (File) - Description of the file to be compressed or decompressed.
```

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

### getLombokConfigTask(Project, SourceSet)

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

Static method to get the Lombok configuration task. Used in ConfigUtil.

```APIDOC
## getLombokConfigTask(Project, SourceSet)

### Description
Static method to get the Lombok configuration task.

### Method
N/A (Static method signature)

### Endpoint
N/A

### Parameters
* **Project** (Project) - Required
* **SourceSet** (SourceSet) - Required

### Request Example
None

### Response
N/A
```

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

### XzArchiver Constructor

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

Initializes a new instance of the XzArchiver class.

```APIDOC
## Constructor XzArchiver

### Description
Initializes a new instance of the `XzArchiver` class.

### Signature
`public XzArchiver(File xzFile)`

### Parameters
* **xzFile** (File) - The file to be compressed or decompressed using XZ format.
```

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

### Getter Methods

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

Methods for retrieving configuration details of the WarOverlay.

```APIDOC
## getConfigurationName()

### Description
Returns the configuration name associated with the overlay.
```

```APIDOC
## getConfigureClosure()

### Description
Returns the closure used for configuring dependencies when the source is resolved.
```

```APIDOC
## getExcludes()

### Description
Returns the set of exclusion patterns for the overlay.
```

```APIDOC
## getIncludes()

### Description
Returns the set of inclusion patterns for the overlay.
```

```APIDOC
## getName()

### Description
Returns the name of the overlay.
```

```APIDOC
## getSource()

### Description
Returns the source of the overlay content. This can be an arbitrary AbstractArchiveTask, another Project with the 'war'-plugin applied, a File instance, or anything that can be used as a Dependency.
```

```APIDOC
## getWarCopySpec()

### Description
Returns the internal CopySpec used for the WAR overlay.
```

```APIDOC
## getWarTask()

### Description
Returns the associated War task.
```

```APIDOC
## isDeferProvidedConfiguration()

### Description
Checks if the 'provided' setting is deferred for the War task. Returns true if deferred (default), false otherwise.
```

```APIDOC
## isEnableCompilation()

### Description
Checks if compilation against the overlay's classes and jars is enabled.
```

```APIDOC
## isEnabled()

### Description
Checks if the overlay is currently enabled.
```

```APIDOC
## isProvided()

### Description
Checks if the overlay is marked as 'provided'.
```

```APIDOC
## isSkip()

### Description
Checks if the overlay is configured to be skipped.
```

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

### Get Repository by Slug

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

Retrieves repository information using a unique slug. This is a default method provided by the interface.

```APIDOC
## getRepository
default retrofit2.Call<Repo> getRepository(String slug)
```

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

### Get Repository by Slug

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

Retrieves a GitHub repository using its slug. This method is a default implementation provided by the interface.

```java
default retrofit2.Call<Repo> getRepository(String slug)
```

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

### GithubBasePlugin Constructor

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

Initializes a new instance of the GithubBasePlugin class.

```APIDOC
## GithubBasePlugin()

### Description
Constructs a new GithubBasePlugin.

### Constructor
`GithubBasePlugin()`
```

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

### from Method

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

Specifies the source for the overlay content.

```APIDOC
## from(Object object)

### Description
Sets the source of the overlay content.

### Parameters
* **object** (Object) - The source, which can be an AbstractArchiveTask, another Project with the 'war'-plugin, a File, or anything usable as a Dependency.
```

```APIDOC
## from(Object object, groovy.lang.Closure configureClosure)

### Description
Sets the source of the overlay content and configures it using a closure.

### Parameters
* **object** (Object) - The source of the overlay content.
* **configureClosure** (groovy.lang.Closure) - A closure for configuring the source.
```

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

### Lombok Usage in Java Sources

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

Example of using Lombok annotations like @Data and @Slf4j in Java source files after applying the plugin.

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

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

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

### createGradleConfiguration

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

Creates a Gradle configuration.

```APIDOC
## createGradleConfiguration

### Description
Creates a Gradle configuration.

### Method Signature
- `createGradleConfiguration()`

### Class
- `io.freefair.gradle.plugins.AbstractPluginTest`
```

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

### Gradle Configuration and Execution

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

Methods for configuring and executing Gradle tasks.

```APIDOC
## createGradleConfiguration

### Description
Creates a builder for configuring the Gradle project.

### Method
protected GradleConfigurationBuilder createGradleConfiguration()

### Returns
A GradleConfigurationBuilder instance.
```

```APIDOC
## executeTask

### Description
Executes the specified Gradle tasks.

### Method
protected BuildResult executeTask(String... taskNames)

### Parameters
- **taskNames** (String...) - A variable number of task names to execute.

### Returns
A BuildResult object containing information about the task execution.
```

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

### Configure Compile-Time Weaving with `io.freefair.aspectj`

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

Apply the `io.freefair.aspectj` plugin for compile-time weaving. This setup is suitable for projects with only Java and AspectJ sources, and it disables the standard `compileJava` task to use `ajc` for compilation.

```gradle
plugins {
    id "io.freefair.aspectj" version "9.5.0"
}

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

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

```gradle
plugins {
    id("io.freefair.aspectj") version "9.5.0"
}

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

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

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

### LombokRuntimeJar Constructor

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

Initializes a new instance of the LombokRuntimeJar task.

```APIDOC
## LombokRuntimeJar

### Description

Constructs a new instance of the LombokRuntimeJar task.

### Constructor

```java
public LombokRuntimeJar()
```
```

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

### HttpGet Task

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

The HttpGet task is an abstract class that extends OkHttpRequestTask, providing functionality to perform HTTP GET requests. It inherits methods for request execution, credential handling, header management, and response processing from its superclasses.

```APIDOC
## HttpGet Task

### Description
This task is used to perform HTTP GET requests. It is an abstract class and serves as a base for specific GET request implementations.

### Class Hierarchy
`java.lang.Object` -> `org.gradle.api.DefaultTask` -> `io.freefair.gradle.plugins.okhttp.tasks.OkHttpTask` -> `io.freefair.gradle.plugins.okhttp.tasks.OkHttpRequestTask` -> `io.freefair.gradle.plugins.okhttp.tasks.HttpGet`

### Methods
#### `buildRequest(okhttp3.Request.Builder builder)`
Overrides the `buildRequest` method from `OkHttpRequestTask` to construct the HTTP request builder for a GET request.

* **Parameters**
  * `builder` (okhttp3.Request.Builder) - The request builder to configure.
```

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

### GithubClient Constructor

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

Initializes a new instance of the GithubClient class.

```APIDOC
## GithubClient Constructor

### Description
Initializes a new instance of the `GithubClient` class.

### Parameters
* **githubExtension** (GithubExtension) - Description not provided.
* **okHttpClient** (okhttp3.OkHttpClient) - Description not provided.
```

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

### apply Method

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

Applies this plugin to the given project.

```APIDOC
## Method: apply

### public void apply(@Nonnull Project project)

Applies this plugin to the given project.

**Specified by:**
`apply` in interface `Plugin<Project>`
```

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

### WarOverlayPlugin.apply Method

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

Applies this plugin to the target project.

```APIDOC
## Method

### apply(Project project)

Applies this plugin to the target project.

**Specified by:**
`apply` in interface `Plugin<Project>`

**Parameters:**
- `project` (Project) - The project to apply the plugin to.
```

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

### Cpio Constructor

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

Initializes a new instance of the Cpio task.

```APIDOC
## Constructor

### Cpio

`public Cpio()`

Initializes a new instance of the Cpio task.
```

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

### cpioTree (no options)

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

Creates a FileTree from a CPIO archive file with default settings.

```APIDOC
## cpioTree

### Description
Creates a FileTree from a CPIO archive file with default settings.

### Method
public FileTree cpioTree(Object cpioFile)

### Parameters
* **cpioFile** (Object) - The CPIO archive file.
```

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

### sevenZipTree (with password)

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

Creates a FileTree from a 7z archive file with a password.

```APIDOC
## sevenZipTree

### Description
Creates a FileTree from a 7z archive file with a password.

### Method
public FileTree sevenZipTree(Object sevenZipFile, char[] password)

### Parameters
* **sevenZipFile** (Object) - The 7z archive file.
* **password** (char[]) - The password for the 7z archive.
```

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

### Create SevenZip Archive

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

Use this task to create .7z archives. Configure the archive file name, destination directory, and source files. You can also specify the content compression method.

```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
}
```

```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
}
```

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

### Configuration Methods

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

Methods for configuring various aspects of the WarOverlay.

```APIDOC
## setConfigureClosure(groovy.lang.Closure configureClosure)

### Description
Sets a closure that is passed to `DependencyHandler.create(Object, Closure)` when the source is resolved as a dependency.

### Parameters
* **configureClosure** (groovy.lang.Closure) - The closure for dependency configuration.
```

```APIDOC
## setDeferProvidedConfiguration(boolean deferProvidedConfiguration)

### Description
Determines whether the 'provided' setting is applied to the War task before its execution. Defaults to true.

### Parameters
* **deferProvidedConfiguration** (boolean) - True to defer provided configuration, false otherwise.
```

```APIDOC
## setEnableCompilation(boolean enableCompilation)

### Description
Enables or disables compilation against the classes and jars of the overlay.

### Parameters
* **enableCompilation** (boolean) - True to enable compilation, false otherwise.
```

```APIDOC
## setEnabled(boolean enabled)

### Description
Enables or disables the overlay.

### Parameters
* **enabled** (boolean) - True to enable the overlay, false to disable.
```

```APIDOC
## setExcludes(Iterable<String> excludes)

### Description
Sets the collection of exclusion patterns for the overlay.

### Parameters
* **excludes** (Iterable<String>) - An iterable of strings representing exclusion patterns.
```

```APIDOC
## setIncludes(Iterable<String> includes)

### Description
Sets the collection of inclusion patterns for the overlay.

### Parameters
* **includes** (Iterable<String>) - An iterable of strings representing inclusion patterns.
```

```APIDOC
## setInto(String destPath)

### Description
Sets the destination path within the WAR archive for the overlay content.

### Parameters
* **destPath** (String) - The destination path.
```

```APIDOC
## setProvided(boolean provided)

### Description
Sets the 'provided' status for the overlay.

### Parameters
* **provided** (boolean) - True to set as provided, false otherwise.
```

```APIDOC
## setSkip(boolean skip)

### Description
Determines whether the overlay should be skipped during the build process.

### Parameters
* **skip** (boolean) - True to skip the overlay, false otherwise.
```

```APIDOC
## setTargetPath(String targetPath)

### Description
Sets the target path for the overlay.

### Parameters
* **targetPath** (String) - The target path.
```

```APIDOC
## setWarCopySpec(org.gradle.api.internal.file.copy.CopySpecInternal warCopySpec)

### Description
Sets the internal CopySpec for the WAR overlay.

### Parameters
* **warCopySpec** (org.gradle.api.internal.file.copy.CopySpecInternal) - The CopySpec to set.
```

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

### GwtPlugin Constructor

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

Initializes a new instance of the GwtPlugin class.

```APIDOC
## GwtPlugin()

### Description
Initializes a new instance of the GwtPlugin class.

### Constructor
`GwtPlugin()`
```

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

### from(Object object, groovy.lang.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 and configures it using a closure.

```APIDOC
## Method from

### Description
Sets the source of the overlay and configures it using a closure.

### Signature
public void from(Object object, groovy.lang.Closure configureClosure)

### Parameters
* **object** (Object) - The source of the overlay.
* **configureClosure** (groovy.lang.Closure) - A closure to configure the source.
```

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

### JavaEE8LinkProvider Constructor

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

Initializes a new instance of the JavaEE8LinkProvider class.

```APIDOC
## JavaEE8LinkProvider()

### Description
Constructs a new JavaEE8LinkProvider.

### Constructor
`JavaEE8LinkProvider()`
```

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

### GithubPackageRegistryMavenPublishPlugin Constructor

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

Initializes a new instance of the GithubPackageRegistryMavenPublishPlugin class.

```APIDOC
## Constructor

### GithubPackageRegistryMavenPublishPlugin()

Initializes a new instance of the `GithubPackageRegistryMavenPublishPlugin` class.
```

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

### GZipWorkAction Constructor

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

Initializes a new instance of the GZipWorkAction class.

```APIDOC
## GZipWorkAction()

### Description
Constructs a new GZipWorkAction.

### Constructor
`GZipWorkAction()`
```

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

### GZip() - GZip

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

Constructor for class io.freefair.gradle.plugins.compress.tasks.GZip.

```APIDOC
## Constructor GZip()

### Class
io.freefair.gradle.plugins.compress.tasks.GZip
```

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

### Build File Loading

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

Method for loading build files from the classpath.

```APIDOC
## loadBuildFileFromClasspath

### Description
Loads a build file from the classpath.

### Method
protected void loadBuildFileFromClasspath(String name) throws IOException

### Parameters
- **name** (String) - The name of the build file to load.

### Throws
IOException
```

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

### ApacheLinkProvider Constructor

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

Initializes a new instance of the ApacheLinkProvider class.

```APIDOC
## ApacheLinkProvider()

### Description
Initializes a new instance of the `ApacheLinkProvider` class.

### Constructor
`ApacheLinkProvider()`
```

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

### GwtWarPlugin Constructor

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

Initializes a new instance of the GwtWarPlugin class.

```APIDOC
## Constructor

### GwtWarPlugin()

Initializes a new instance of the `GwtWarPlugin` class.
```

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

### Create Ar Archive with Kotlin

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

Use this task to create 'ar' archives. Specify the archive file name, destination directory, and the source files to include.

```kotlin
tasks.register<io.freefair.gradle.plugins.compress.tasks.Ar>("packageArArchive") {
    archiveFileName = "my-distribution.ar"
    destinationDirectory = file("$buildDir/dist")

    from("$buildDir/toArchive")

    longFileMode = org.apache.commons.compress.archivers.ar.ArArchiveOutputStream.LONGFILE_ERROR
}
```

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

### Job Constructor

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

Initializes a new instance of the Job class.

```APIDOC
## Job()

### Description
Initializes a new instance of the Job class.

### Method
Constructor

### Code
public Job()
```

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

### GwtBasePlugin Constructor

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

Initializes a new instance of the GwtBasePlugin class.

```APIDOC
## Constructor

### GwtBasePlugin

`public GwtBasePlugin()`

Initializes a new instance of the `GwtBasePlugin` class.
```

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

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

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

Configures Lombok with the specified output stream and file paths.

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

### Description
Configures Lombok with the specified output stream and file paths.

### Method
`void config(OutputStream outputStream, File... paths)`

### Parameters
#### Path Parameters
- **outputStream** (OutputStream) - Required - The output stream to use for configuration.
- **paths** (File...) - Required - A variable number of file paths to configure.
```

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

### Manifest.File Methods

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

Details the methods available for interacting with Manifest.File objects.

```APIDOC
## getSource_location Method

### Description
Retrieves the path of the manifest file relative to the root of the Git repository.

### Signature
`public String getSource_location()`

### Returns
(String) - The path of the manifest file.

## setSource_location Method

### Description
Sets the path of the manifest file relative to the root of the Git repository.

### Signature
`public void setSource_location(String source_location)`

### Parameters
* `source_location` (String) - Required - The path of the manifest file relative to the root of the Git repository.

## equals Method

### Description
Compares this `File` object to another object for equality.

### Signature
`public boolean equals(Object o)`

### Overrides
`equals` in class `Object`

## canEqual Method

### Description
Indicates whether some other object is "equal to" this one.

### Signature
`protected boolean canEqual(Object other)`

## hashCode Method

### Description
Returns a hash code value for the object.

### Signature
`public int hashCode()`

### Overrides
`hashCode` in class `Object`

## toString Method

### Description
Returns a string representation of the object.

### Signature
`public String toString()`

### Overrides
`toString` in class `Object`
```

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

### BZip2WorkAction Constructor

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

Initializes a new instance of the BZip2WorkAction class.

```APIDOC
## BZip2WorkAction()

### Description
Constructs a new BZip2WorkAction.

### Constructor
`public BZip2WorkAction()`
```

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

### apply Method

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

Applies this plugin to the target project.

```APIDOC
## apply(Project project)

### Description
Applies the plugin to the given project.

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

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

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

### GZip.GZipWorkAction() - GZip.GZipWorkAction

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

Constructor for class io.freefair.gradle.plugins.compress.tasks.GZip.GZipWorkAction.

```APIDOC
## Constructor GZip.GZipWorkAction()

### Class
io.freefair.gradle.plugins.compress.tasks.GZip.GZipWorkAction
```

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

### Create Cpio Archive with Groovy

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

Use this task to create 'cpio' archives. Configure the archive file name, destination directory, source files, and cpio format specific options like block size and encoding.

```groovy
task packageCpioArchive(type: io.freefair.gradle.plugins.compress.tasks.Cpio) {
    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"
}
```

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

### ProjectContext Methods

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

Provides methods for accessing project configuration and file operations.

```APIDOC
## Methods

### `configurationExists(String key)`

#### Description
Checks if a configuration value with the given key exists.

#### Parameters
* **key** (String) - The key of the configuration value to check.

#### Returns
* `boolean` - `true` if the configuration exists, `false` otherwise.
```

```APIDOC
## Method `getAllFiles()`

### Description
Retrieves all files within the project context.

### Returns
* `List<ProjectFile>` - A list of ProjectFile objects.
```

```APIDOC
## Method `getConfigurationValue(String key)`

### Description
Retrieves a configuration value by its key.

### Parameters
* **key** (String) - The key of the configuration value to retrieve.

### Returns
* `Object` - The configuration value associated with the key.
```

```APIDOC
## Method `getConfigurationValueAs(String key, Class<T> clazz)`

### Description
Retrieves a configuration value by its key and casts it to the specified class.

### Parameters
* **key** (String) - The key of the configuration value to retrieve.
* **clazz** (Class<T>) - The class to cast the configuration value to.

### Returns
* `<T> T` - The configuration value cast to the specified class.
```

```APIDOC
## Method `getNamespaceFromFile(File file)`

### Description
Determines the namespace for a given file.

### Parameters
* **file** (File) - The file for which to determine the namespace.

### Returns
* `String` - The namespace of the file.
```

```APIDOC
## Method `getInputDir()`

### Description
Gets the input directory of the project.

### Returns
* `File` - The input directory.
```

```APIDOC
## Method `getOutputDir()`

### Description
Gets the output directory of the project.

### Returns
* `File` - The output directory.
```

```APIDOC
## Method `getRootDir()`

### Description
Gets the root directory of the project.

### Returns
* `File` - The root directory.
```

```APIDOC
## Method `getSourceSet()`

### Description
Gets the source set name.

### Returns
* `String` - The source set name.
```

```APIDOC
## Method `readFile(String namespace, String filename)`

### Description
Reads the content of a file within a specific namespace.

### Parameters
* **namespace** (String) - The namespace of the file.
* **filename** (String) - The name of the file to read.

### Returns
* `String` - The content of the file as a string.

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

```APIDOC
## Method `readFile(String namespace, String filename, String encoding)`

### Description
Reads the content of a file within a specific namespace using a specified encoding.

### Parameters
* **namespace** (String) - The namespace of the file.
* **filename** (String) - The name of the file to read.
* **encoding** (String) - The character encoding to use.

### Returns
* `String` - The content of the file as a string.

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

```APIDOC
## Method `readFileToByteArray(String namespace, String filename)`

### Description
Reads the content of a file within a specific namespace into a byte array.

### Parameters
* **namespace** (String) - The namespace of the file.
* **filename** (String) - The name of the file to read.

### Returns
* `byte[]` - The content of the file as a byte array.

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

```APIDOC
## Method `writeOutputFile(String namespace, String filename, byte[] content)`

### Description
Writes byte array content to an output file within a specific namespace.

### Parameters
* **namespace** (String) - The namespace for the output file.
* **filename** (String) - The name of the output file.
* **content** (byte[]) - The byte array content to write.

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

```APIDOC
## Method `writeOutputFile(String namespace, String filename, String content)`

### Description
Writes string content to an output file within a specific namespace.

### Parameters
* **namespace** (String) - The namespace for the output file.
* **filename** (String) - The name of the output file.
* **content** (String) - The string content to write.

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

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

### DownloadFile Task Configuration

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

This snippet shows how to configure the DownloadFile task, including setting the output file for the download.

```APIDOC
## DownloadFile Task

### Description
This task extends `HttpGet` and is designed to download files. It provides an abstract method `getOutputFile()` to specify where the downloaded content should be saved.

### Methods

#### `getOutputFile()`

*   **Description**: Returns a `RegularFileProperty` that defines the output file for the download.
*   **Modifier**: `abstract`
*   **Return Type**: `RegularFileProperty`

#### `handleResponse(okhttp3.Response response)`

*   **Description**: Handles the HTTP response from the download request. This method is called after the request is executed and can be overridden to process the response, for example, to save the file content.
*   **Modifier**: `public`
*   **Parameters**:
    *   `response` (okhttp3.Response) - The HTTP response object.
*   **Throws**: `IOException`
*   **Overrides**: `handleResponse` in class `OkHttpRequestTask`
```

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

### GithubPomPlugin Constructor

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

Initializes a new instance of the GithubPomPlugin class.

```APIDOC
## Constructor

### `GithubPomPlugin()`

Initializes a new instance of the `GithubPomPlugin` class.
```

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

### provided Methods

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

Methods for configuring the 'provided' status of the overlay.

```APIDOC
## provided()

### Description
Sets the overlay to be 'provided'.
```

```APIDOC
## provided(boolean provided)

### Description
Enables or disables the 'provided' status for the overlay.

### Parameters
* **provided** (boolean) - True to set as provided, false otherwise.
```

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

### LombokBasePlugin Constructor

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

Initializes a new instance of the LombokBasePlugin class.

```APIDOC
## LombokBasePlugin()

### Description
Constructs a new instance of the LombokBasePlugin.

### Constructor
`LombokBasePlugin()`
```

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

### MultiModuleFixAction Constructor

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

Initializes a new instance of the MultiModuleFixAction class.

```APIDOC
## MultiModuleFixAction()

### Description
Constructs a new MultiModuleFixAction.

### Constructor
`MultiModuleFixAction()`
```

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

### SevenZipArchiveInputStream Constructor

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

Initializes a new instance of the SevenZipArchiveInputStream class.

```APIDOC
## SevenZipArchiveInputStream(SevenZFile sevenZFile)

### Description
Constructs a new SevenZipArchiveInputStream using a provided SevenZFile.

### Parameters
* **sevenZFile** (SevenZFile) - The SevenZFile to read from.
```