Package org.machanism.machai.cli

Class CleanCommand

java.lang.Object

org.machanism.machai.cli.CleanCommand

@ShellComponent
public class CleanCommand
extends Object

Provides shell commands for cleaning up Machai temporary folders.

The CleanCommand class includes methods for removing all ".machai" template folders within a specified root directory.

Usage Example:

 
 CleanCommand cleanCmd = new CleanCommand();
 cleanCmd.clean(new File("/path/to/root"));
 
 

Since:

0.0.2

Author:

Viktor Tovstyi

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MACHAI_TEMP_DIR	Name of the Machai temporary directory.

Constructor Summary

Constructors

Constructor	Description
CleanCommand()

Method Summary

Modifier and Type	Method	Description
void	clean(File dir)	Removes all ".machai" template folders from the provided root directory.
static void	removeAllDirectoriesByName(Path rootPath, String dirName)	Removes all directories with the specified name from the given root path.

Methods inherited from class java.lang.Object

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

Field Details

MACHAI_TEMP_DIR

public static final String MACHAI_TEMP_DIR

Name of the Machai temporary directory.

See Also:

• Constant Field Values

Constructor Details

CleanCommand

public CleanCommand()

Method Details

clean

@ShellMethod("Removes all .machai template folders from the root directory.")
public void clean(@ShellOption(help="The path fo the project directory.",defaultValue="__NULL__",value="dir")
 File dir)
           throws IOException

Removes all ".machai" template folders from the provided root directory.

Parameters:

dir - The path to the project directory. If null, uses the user directory.

Throws:

IOException - if the cleanup process fails

removeAllDirectoriesByName

public static void removeAllDirectoriesByName(Path rootPath,
 String dirName)
                                       throws IOException

Removes all directories with the specified name from the given root path.

Parameters:

rootPath - The root directory to start the search.

dirName - The name of directories to remove.

Throws:

IOException - If an I/O error occurs.