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

Improve the javadoc of RecorderContext#classProxy() #34607

Merged
merged 1 commit into from
Jul 11, 2023
Merged

Improve the javadoc of RecorderContext#classProxy() #34607

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
10 changes: 6 additions & 4 deletions core/deployment/src/main/java/io/quarkus/deployment/recording/RecorderContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,14 @@ <F, T> void registerSubstitution(Class<F> from, Class<T> to,
* Creates a Class instance that can be passed to a recording proxy as a substitute for a class that is not loadable
* at processing time. At runtime the actual class will be passed into the invoked method.
*
* @param name The class name
* @param name The fully-qualified class name
* @return A Class instance that can be passed to a recording proxy
* @deprecated This construct is no longer needed since directly loading deployment/application classes at
* processing time in build steps is now safe
* @deprecated This construct should not be needed in most use cases since directly loading deployment/application classes
* at processing time in build steps is safe. However, there are use cases where this method comes in handy,
* such as referring to classes that were generated in previous build steps using
* {@link io.quarkus.deployment.builditem.GeneratedClassBuildItem}.
*/
@Deprecated
@Deprecated(forRemoval = false)
Class<?> classProxy(String name);

/**
Expand Down
8 changes: 5 additions & 3 deletions docs/src/main/asciidoc/writing-extensions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1544,9 +1544,11 @@ this includes the ability to register creation functions for classes without no-
substitution (basically a transformer from a non-serializable object to a serializable one and vice versa), and to create
a class proxy. This interface can be directly injected as a method parameter into any `@Record` method.

Calling `classProxy` with a given class name will create a `Class` that can be passed into recorder
methods, and at runtime will be substituted with the class whose name was passed in to `classProxy`. This is basically a
convenience to avoid the need to explicitly load classes in the recorders.
Calling `classProxy` with a given fully-qualified class name will create a `Class` instance that can be passed into a recorder
method, and at runtime will be substituted with the class whose name was passed in to `classProxy()`.
However, this method should not be needed in most use cases because directly loading deployment/application classes at processing time in build steps is safe.
Therefore, this method is deprecated.
Nonetheless, there are some use cases where this method comes in handy, such as referring to classes that were generated in previous build steps using `GeneratedClassBuildItem`.

==== Printing step execution time

Expand Down