Skip to content

Commit

Permalink
chore: update javadoc to reflect implementation (#2053)
Browse files Browse the repository at this point in the history
* chore: update javadoc to reflect implementation

* fixed typo

Co-authored-by: Peter Vlugter <[email protected]>

---------

Co-authored-by: Peter Vlugter <[email protected]>
  • Loading branch information
octonato and pvlugter authored Mar 6, 2024
1 parent 02841bc commit 0c95595
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@
import java.lang.annotation.Target;

/**
* Annotation to assign a logical type name to persisted events.
* Annotation to assign a logical type name to events.
*
* Kalix needs to identify each event in order to deliver them to the right event handlers.
* If a logical type name isn't specified, Kalix will use the non-qualified class name.
* If a logical type name isn't specified, Kalix will use the fully qualified class name.
*
* Once an event is persisted in Kalix, you won't be able to rename your class if no logical type name
* has been specified, as Kalix won't be able to recognize previously persisted events.
Expand All @@ -37,7 +37,7 @@
public @interface TypeName {

/** Logical type name for the annotated type.
* If missing (or defined as Empty String), the non-qualified class name will be used.
* If missing (or defined as Empty String), the fully qualified class name will be used.
*/
String value() default "";
}

0 comments on commit 0c95595

Please sign in to comment.