Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class DebugOutput

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.DebugOutput

@ClassVersion(sourceVersion="$Id: DebugOutput.java 1063 2023-09-26 15:14:16Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.6")
public final class DebugOutput
extends Object

A helper class holding the debug output that is added to the generated code. This allows a quick reference to the source code that was responsible for the generation of the respective element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: DebugOutput.java 1063 2023-09-26 15:14:16Z tquadrat $

Since:

0.0.6

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.DebugOutput"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final String	m_Text	The text for the debug output.

Constructor Summary

Constructors

Constructor	Description
DebugOutput(Optional<StackTraceElement> stackTraceElement)	Creates a new DebugOutput instance.

Method Summary

Modifier and Type	Method	Description
final String	asComment()	Returns the text for the debug output.
final String	asLiteral()	Returns the text for the debug output.
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

m_Text

private final String m_Text

The text for the debug output.

Constructor Details

DebugOutput

public DebugOutput(Optional<StackTraceElement> stackTraceElement)

Creates a new DebugOutput instance.

Parameters:

stackTraceElement - The stack trace element for the caller's caller.

Method Details

asComment

public final String asComment()

Returns the text for the debug output.

Returns:

The comment.

asLiteral

public final String asLiteral()

Returns the text for the debug output.

Returns:

The text.

toString

public final String toString()

Overrides:

toString in class Object