Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve @DataMapping javadoc #264

Merged
merged 1 commit into from
Nov 9, 2024
Merged

Improve @DataMapping javadoc #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions roq-data/runtime/src/main/java/io/quarkiverse/roq/data/runtime/annotations/DataMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}