Annotation Interface CR

@ClassVersion(sourceVersion="$Id: CR.java 1294 2026-10-17 15:40:42Z tquadrat $")
@API(status=STABLE,
     since="0.25.14")
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,LOCAL_VARIABLE,METHOD,MODULE,PACKAGE,PARAMETER,RECORD_COMPONENT,TYPE,TYPE_PARAMETER,TYPE_USE})
@Repeatable(ChangeRequestList.class)
public @interface CR

This annotation allows to add information about applied fixes (aka. "Change Requests") to a program element.

This annotation does not appear in the Javadoc documentation of the annotated program elements.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: CR.java 1294 2026-10-17 15:40:42Z tquadrat $

Since:

0.25.14

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.annotation.CR"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CR.CRType	Types of change requests.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	id	The id for the change request as provided by the respective tracking system.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	comment	An optional comment regarding the change.
String	date	The date when the change was applied, in the format "YYYY-mm-dd".
CR.CRType	type	The type for the change request.

Element Details

comment

String comment

An optional comment regarding the change.

Returns:

The comment.

Default:

""

date

String date

The date when the change was applied, in the format "YYYY-mm-dd". Will be ignored if empty.

Returns:

The change date.

See Also:

• Formatter

Default:

""

id

String id

The id for the change request as provided by the respective tracking system.

Returns:

The change request id.

type

CR.CRType type

The type for the change request.

Returns:

The type of the change request.

Default:

CR