jakartaee / jakartaee/rest

Specification text and DefaultValue/Encoded docs should clarify where annotations have to be located on bean setters for them to be effective

Open
#455 3 comments 0 reactions 1 assignee View on GitHub

@spericas is already working on this.

Since Feb 10, 2018.

Component: model api Component: spec
Dominant language
Java
Stars
400
Forks
143
PR merge metrics
No merged PRs in 30d

Description

We have a user request implying that the following is correct:
(1)

public class Root {
   @QueryParam("{id}")
   @A
   @B
   @Encoded 
   @DefaultValue("1")
   public void setId(String id) {}
}

as opposed to

(2)

public class Root {
   @QueryParam("{id}")
   public void setId(@A @B @Encoded @DefaultValue("1") String id) {}
}

It is not really obvious which version is right or if both versions are OK. JAX-RS @Encoded and @DefaultValue can target Methods but it is not obvious @A & @B can. For example, they may have been built originally with the idea that they would be applied to resource method parameters, which is often a typical case.

Specifically, the question came up in scope of discussing passing annotations to ParamConverterProvider on BeanParam setters.
In fact ParamConverterProvider documentation provides the only hint that it is really the option (2) which is correct, "E.g. if a string value is to be converted into a method parameter, this would be the annotations on that parameter as returned by Method.getParameterAnnotations()."

IMHO some further clarifications will help.

Affected Versions

[2.0]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.