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

Deprecate @ConfigItem and deprecated attributes of @ConfigRoot #45781

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Deprecate @ConfigItem and deprecated attributes of @ConfigRoot #45781

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions core/runtime/src/main/java/io/quarkus/runtime/annotations/ConfigItem.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@

/**
* A single container configuration item.
*
* @deprecated Use interface-based {@code @ConfigMapping} instead.
*/
@Retention(RUNTIME)
@Target({ FIELD, PARAMETER })
@Documented
@Deprecated(since = "3.19", forRemoval = true)
public @interface ConfigItem {

/**
Expand Down
7 changes: 7 additions & 0 deletions core/runtime/src/main/java/io/quarkus/runtime/annotations/ConfigRoot.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@
* Determine the prefix key of the configuration root.
*
* @return the prefix key name
* @deprecated Use interface-based {@code @ConfigMapping} instead. When moving to {@code @ConfigMapping}, the prefix has to
* be included in the {@code @ConfigMapping#prefix} together with the name.
*/
@Deprecated(since = "3.19", forRemoval = true)
String prefix() default "quarkus";

/**
Expand All @@ -35,6 +38,10 @@
* Determine the base key of the configuration root.
*
* @return the base key name
* @deprecated Use interface-based {@code @ConfigMapping} instead. Be careful, {@code @ConfigRoot(name = "extension")} may
* be migrated to {@code @ConfigMapping(prefix = "quarkus.extension")}. If no name was defined, make sure to
* define a prefix in {@code @ConfigMapping} as it's mandatory.
*/
@Deprecated(since = "3.19", forRemoval = true)
String name() default ConfigItem.HYPHENATED_ELEMENT_NAME;
}
Loading