Record Class MarkdownDocumentationCommentsExamples.JavaDocResult

java.lang.Object

java.lang.Record

net.jrodolfo.java_evolution.java23.markdown_documentation_comments.MarkdownDocumentationCommentsExamples.JavaDocResult

Record Components:

exitCode - process exit code

output - merged standard output and standard error

documentationDirectory - generated documentation directory

Enclosing class:

MarkdownDocumentationCommentsExamples

public static record MarkdownDocumentationCommentsExamples.JavaDocResult(int exitCode, String output, Path documentationDirectory)
extends Record

Captures the JavaDoc child process result.

Constructor Summary

Constructors

Constructor	Description
JavaDocResult(int exitCode, String output, Path documentationDirectory)	Creates an instance of a JavaDocResult record class.

Method Summary

Modifier and Type	Method	Description
Path	documentationDirectory()	Returns the value of the documentationDirectory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	exitCode()	Returns the value of the exitCode record component.
final int	hashCode()	Returns a hash code value for this object.
String	output()	Returns the value of the output record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

JavaDocResult

public JavaDocResult(int exitCode,
 String output,
 Path documentationDirectory)

Creates an instance of a JavaDocResult record class.

Parameters:

exitCode - the value for the exitCode record component

output - the value for the output record component

documentationDirectory - the value for the documentationDirectory record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

exitCode

public int exitCode()

Returns the value of the exitCode record component.

Returns:

the value of the exitCode record component

output

public String output()

Returns the value of the output record component.

Returns:

the value of the output record component

documentationDirectory

public Path documentationDirectory()

Returns the value of the documentationDirectory record component.

Returns:

the value of the documentationDirectory record component