Package org.machanism.machai.maven

Class Clean

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.machanism.machai.maven.Clean

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="clean",
      defaultPhase=CLEAN)
public class Clean
extends org.apache.maven.plugin.AbstractMojo

Maven Mojo to clean up temporary AI-generated documentation inputs.

This plugin step removes the `.machai/docs-inputs` log file from the Maven project directory, allowing a fresh documentation generation workflow in subsequent runs.

 Example Usage in POM:
 <plugin>
   <groupId>org.machanism.machai</groupId>
   <artifactId>gw-maven-plugin</artifactId>
   <version>${project.version}</version>
   <executions>
     <execution>
       <goals>
         <goal>clean</goal>
       </goals>
     </execution>
   </executions>
 </plugin>
 

Since:

0.0.2

Author:

Viktor Tovstyi

Field Summary

Fields

Modifier and Type	Field	Description
protected File	basedir	The Maven project base directory.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
Clean()

Method Summary

Modifier and Type	Method	Description
void	execute()	Deletes the temporary documentation input log file from the project directory.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

basedir

@Parameter(defaultValue="${basedir}",
           required=true,
           readonly=true)
protected File basedir

The Maven project base directory.

Constructor Details

Clean

public Clean()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Deletes the temporary documentation input log file from the project directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs when deleting the file