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

Update javadoc of RequestContextController with suggested usage #825

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Update javadoc of RequestContextController with suggested usage #825

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
17 changes: 10 additions & 7 deletions api/src/main/java/jakarta/enterprise/context/control/RequestContextController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import jakarta.enterprise.context.ContextNotActiveException;

/**
* The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes
* The CDI container provides a built-in instance of {@code RequestContextController} that is dependent scoped for the purposes
* of activating and deactivating. For example:
*
* <pre>
Expand All @@ -26,12 +26,15 @@
*
* public void doRequest(String body) {
* // activate request context
* requestContextController.activate();
*
* // do work in a request context.
*
* // deactivate the request context
* requestContextController.deactivate();
* boolean activated = requestContextController.activate();
* try {
* // do work in a request context.
* } finally {
* // deactivate the request context if we activated it earlier
* if (activated) {
* requestContextController.deactivate();
* }
* }
* }
* </pre>
*
Expand Down