Class JavadocIntent

java.lang.Object

uno.anahata.asi.nb.tools.java.coderefiner.JavadocIntent

All Implemented Interfaces:

Serializable

public class JavadocIntent
extends Object
implements Serializable

A structured representation of a Javadoc comment.

Used within CodeRefinementIntent to allow the LLM to provide structured Javadoc alongside code modifications, bypassing RPM limits.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	authors	The list of author names associated with the @author tag.
private String	description	The main Javadoc description (Markdown or HTML).
private Map<String,String>	params	A map of parameter names to their descriptions for the @param tag.
private String	returns	The description of the return value for the @return tag.
private List<String>	since	The list of versions associated with the @since tag.
private List<String>	tags	Optional list of additional block tags (e.g.
private Map<String,String>	thrownExceptions	A map of exception FQNs to their descriptions for the @throws tag.

Constructor Summary

Constructors

Constructor	Description
JavadocIntent()

Method Summary

Modifier and Type	Method	Description
String	generateString()	Generates the multi-line Javadoc comment string from the current state.

Methods inherited from class Object

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

Field Details

description

private String description

The main Javadoc description (Markdown or HTML). Supports inline tags like {@inheritDoc}, {@link}, {@code}.

authors

private List<String> authors

The list of author names associated with the @author tag.

since

private List<String> since

The list of versions associated with the @since tag.

params

private Map<String,String> params

A map of parameter names to their descriptions for the @param tag.

returns

private String returns

The description of the return value for the @return tag.

thrownExceptions

private Map<String,String> thrownExceptions

A map of exception FQNs to their descriptions for the @throws tag.

tags

private List<String> tags

Optional list of additional block tags (e.g. ['version 1.0', 'see OtherClass']).

Constructor Details

JavadocIntent

public JavadocIntent()

Method Details

generateString

public String generateString()

Generates the multi-line Javadoc comment string from the current state.

Returns:

a standard Javadoc block.