Package rife.bld.extension

Class GeneratedVersionOperation

java.lang.Object

rife.bld.operations.AbstractOperation<GeneratedVersionOperation>

rife.bld.extension.GeneratedVersionOperation

@NullMarked
public class GeneratedVersionOperation
extends AbstractOperation<GeneratedVersionOperation>

Generates a project version data class.

Since:

1.0

Author:

Erik C. Thauvin

Constructor Summary

Constructors

Constructor	Description
GeneratedVersionOperation()

Method Summary

Modifier and Type	Method	Description
GeneratedVersionOperation	className(String className)	Sets the class name.
GeneratedVersionOperation	classTemplate(File template)	Sets the class template path.
GeneratedVersionOperation	classTemplate(String template)	Sets the class template path.
GeneratedVersionOperation	classTemplate(Path template)	Sets the class template path.
GeneratedVersionOperation	directory(File directory)	Sets the destination directory.
GeneratedVersionOperation	directory(String directory)	Sets the destination directory.
GeneratedVersionOperation	directory(Path directory)	Sets the destination directory.
void	execute()
GeneratedVersionOperation	extension(String extension)	Sets the file extension.
GeneratedVersionOperation	fromProject(BaseProject project)	Configure the operation from a BaseProject.
GeneratedVersionOperation	generateAnnotation(boolean generate)	Determines if the Generated annotation class file should be created.
GeneratedVersion	generatedVersion()	Retrieves the generated version instance.
GeneratedVersionOperation	packageName(String packageName)	Sets the package name.
GeneratedVersionOperation	projectName(String projectName)	Sets the project name.

Methods inherited from class rife.bld.operations.AbstractOperation

executeOnce, executeOnce, silent, silent, verbose, verbose

Methods inherited from class java.lang.Object

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

Constructor Details

GeneratedVersionOperation

public GeneratedVersionOperation()

Method Details

execute

public void execute()
             throws ExitStatusException

Specified by:

execute in class AbstractOperation<GeneratedVersionOperation>

Throws:

ExitStatusException

className

public GeneratedVersionOperation className(String className)

Sets the class name.

Parameters:

className - the class name

Returns:

this operation instance

Throws:

NullPointerException - if className is null

IllegalArgumentException - if className is empty or invalid

classTemplate

public GeneratedVersionOperation classTemplate(String template)

Sets the class template path.

Parameters:

template - the template path

Returns:

this operation instance

Throws:

NullPointerException - if template is null

IllegalArgumentException - if template is blank

classTemplate

public GeneratedVersionOperation classTemplate(File template)

Sets the class template path.

Parameters:

template - the template path

Returns:

this operation instance

Throws:

NullPointerException - if template is null

classTemplate

public GeneratedVersionOperation classTemplate(Path template)

Sets the class template path.

Parameters:

template - the template path

Returns:

this operation instance

Throws:

NullPointerException - if template is null

directory

public GeneratedVersionOperation directory(String directory)

Sets the destination directory.

Parameters:

directory - the destination directory

Returns:

this operation instance

Throws:

NullPointerException - if directory is null

directory

public GeneratedVersionOperation directory(File directory)

Sets the destination directory.

Parameters:

directory - the destination directory

Returns:

this operation instance

Throws:

NullPointerException - if directory is null

directory

public GeneratedVersionOperation directory(Path directory)

Sets the destination directory.

Parameters:

directory - the destination directory

Returns:

this operation instance

Throws:

NullPointerException - if directory is null

extension

public GeneratedVersionOperation extension(String extension)

Sets the file extension. (Default is: .java)

The extension is stripped of leading/trailing whitespace and must start with a . followed by at least one non-whitespace character (e.g., .java, .kt).

Parameters:

extension - the file extension

Returns:

this operation instance

Throws:

NullPointerException - if extension is null

IllegalArgumentException - if extension after trimming is not a . followed by at least one character

fromProject

public GeneratedVersionOperation fromProject(BaseProject project)

Configure the operation from a BaseProject.

Sets the following GeneratedVersion options:

• The project to the given project.
• The destination directory to the project's main java source directory, if not already set.

Parameters:

project - the project

Returns:

this operation instance

Throws:

NullPointerException - if project is null

generateAnnotation

public GeneratedVersionOperation generateAnnotation(boolean generate)

Determines if the Generated annotation class file should be created.

The class file is not overwritten if it already exists.

Parameters:

generate - true to generate the annotation; false otherwise

Returns:

this operation instance

generatedVersion

public GeneratedVersion generatedVersion()

Retrieves the generated version instance.

The returned object is intentionally mutable. It provides access to properties not directly exposed by this operation's fluent API.

Returns:

the generated version

packageName

public GeneratedVersionOperation packageName(String packageName)

Sets the package name.

Parameters:

packageName - the package name

Returns:

this operation instance

Throws:

NullPointerException - if packageName is null

projectName

public GeneratedVersionOperation projectName(String projectName)

Sets the project name.

Parameters:

projectName - the project name

Returns:

this operation instance

Throws:

NullPointerException - if projectName is null