eclipse-ee4j / eclipse-ee4j/jersey
Clarify Javadoc for ServletDeploymentContext and ServletDeploymentContext.Builder
Open
Component: test-framework
Priority: Minor
Type: Improvement
- Dominant language
- Java
- Stars
- 730
- Forks
- 382
- PR merge metrics
- No merged PRs in 30d
Description
While the Javadoc for these classes is technically correct, it is quite brief. Elaborating on the meaning of ServletDeploymentContext and ServletDeploymentContext.Builder's init and context parameters will help users understand what is going on.
To that end, please indicate that init parameters are bound to Jersey's servlet or filter, and will be returned by ServletConfig.getInitParameter() or FilterConfig.getInitParameter(), respectively.
For ServletDeploymentContext.getContextParams() please indicate that these are context-wide (not bound to the servlet/filter) and will be returned by ServletContext.getInitParameter().
#### Affected Versions
[2.8]
Contributor guide
Assessment
This issue has not been assessed yet.