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

Remove defunct phase and add paragraph about config root suffixes #2920

Merged
merged 1 commit into from
Jun 22, 2019
Merged

Remove defunct phase and add paragraph about config root suffixes #2920

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
12 changes: 5 additions & 7 deletions docs/src/main/asciidoc/extension-authors-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,11 @@ A configuration root's name can be given with the `name` property, or it can be
then the configuration key will be the class name, minus any `Config` or `Configuration` suffix, broken up by camel-case,
lowercased, and re-joined using hyphens (`-`).

A configuration root's class name can contain an extra suffix segment for the case where there are configuration
roots for multiple <<Configuration Root Phases>>. Classes which correspond to the `BUILD_TIME` and `BUILD_AND_RUN_TIME_FIXED`
may end with `BuildTimeConfig` or `BuildTimeConfiguration`, and classes which correspond to the `RUN_TIME` phase
may end with `RunTimeConfig` or `RunTimeConfiguration`.

Note: The current implementation is still using injection site to determine the root set, so to avoid migration problems, it
is recommended that the injection site (field or parameter) have the same name as the configuration root class until
this change is complete.
Expand Down Expand Up @@ -450,13 +455,6 @@ A configuration root dictates when its contained keys are read from configuratio
| ✗
| Appropriate for things which affect build and must be visible for run time code. Not read from config at run time.

| RUN_TIME_STATIC
| ✗
| ✓
| ✓
| ✗
| Not available at build, read on start in JVM mode, fixed in native executable mode.

| RUN_TIME
| ✗
| ✓
Expand Down