From 210175caac295777b0cbabe6f65065dc61c2269b Mon Sep 17 00:00:00 2001 From: Matheus Cruz Date: Sat, 9 Nov 2024 11:37:50 -0300 Subject: [PATCH] Improve javadoc --- .../roq/data/runtime/annotations/DataMapping.java | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/roq-data/runtime/src/main/java/io/quarkiverse/roq/data/runtime/annotations/DataMapping.java b/roq-data/runtime/src/main/java/io/quarkiverse/roq/data/runtime/annotations/DataMapping.java index 5895f09c..ca36a33c 100644 --- a/roq-data/runtime/src/main/java/io/quarkiverse/roq/data/runtime/annotations/DataMapping.java +++ b/roq-data/runtime/src/main/java/io/quarkiverse/roq/data/runtime/annotations/DataMapping.java @@ -13,7 +13,20 @@ @Target({ ElementType.TYPE }) @Documented public @interface DataMapping { + + /** + * Indicates the name of the data file, excluding the file extension. + * This name should match the data source file used for mapping purposes. + * + * @return the data file name without its extension + */ String value(); + /** + * Indicates if the root element of the data file is structured as an array. + * Set this to {@code true} if the root element is an array; otherwise, {@code false}. + * + * @return {@code true} if the root element is an array, {@code false} otherwise + */ boolean parentArray() default false; }