Package com.pragma.archetype.domain.model.file

Record Class GeneratedFile

java.lang.Object

java.lang.Record

com.pragma.archetype.domain.model.file.GeneratedFile

public record GeneratedFile(Path path, String content, FileType type)
extends Record

Represents a file to be generated. Uses Java 21 record for immutability.

Constructor Summary

Constructors

Constructor	Description
GeneratedFile(Path path, String content, FileType type)	Creates an instance of a GeneratedFile record class.

Method Summary

Modifier and Type	Method	Description
String	content()	Returns the value of the content record component.
static GeneratedFile	create(Path path, String content)	Creates a generic file with automatic type detection.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static GeneratedFile	gradleBuild(Path path, String content)	Creates a Gradle build file.
final int	hashCode()	Returns a hash code value for this object.
static GeneratedFile	javaSource(Path path, String content)	Creates a Java source file.
static GeneratedFile	markdown(Path path, String content)	Creates a markdown file.
Path	path()	Returns the value of the path record component.
final String	toString()	Returns a string representation of this record class.
FileType	type()	Returns the value of the type record component.
static GeneratedFile	yamlConfig(Path path, String content)	Creates a YAML configuration file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GeneratedFile

public GeneratedFile(Path path,
 String content,
 FileType type)

Creates an instance of a GeneratedFile record class.

Parameters:

path - the value for the path record component

content - the value for the content record component

type - the value for the type record component

Method Details

javaSource

public static GeneratedFile javaSource(Path path,
 String content)

Creates a Java source file.

gradleBuild

public static GeneratedFile gradleBuild(Path path,
 String content)

Creates a Gradle build file.

yamlConfig

public static GeneratedFile yamlConfig(Path path,
 String content)

Creates a YAML configuration file.

markdown

public static GeneratedFile markdown(Path path,
 String content)

Creates a markdown file.

create

public static GeneratedFile create(Path path,
 String content)

Creates a generic file with automatic type detection.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

path

public Path path()

Returns the value of the path record component.

Returns:

the value of the path record component

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

type

public FileType type()

Returns the value of the type record component.

Returns:

the value of the type record component