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.

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 Javadoc of GeneratedMethods#add to describe naming conventions #28997

Closed
snicoll opened this issue Aug 23, 2022 · 0 comments
Closed

Improve Javadoc of GeneratedMethods#add to describe naming conventions #28997

snicoll opened this issue Aug 23, 2022 · 0 comments
Assignees
Labels
theme: aot An issue related to Ahead-of-time processing type: documentation A documentation task
Milestone

Comments

@snicoll
Copy link
Member

snicoll commented Aug 23, 2022

Using GeneratedMethods#add with getInstance for a given bean name generates getBeanNameInstance. The javadoc of add mentions that getInstance is the suggested name.

get, set and is are special in the suggested name. It'll be considered a prefix, followed by the qualifier and then the remaining of the suggested part. Someone using the same code with determineInstance would not get the same behavior.

Considering that the suggested name will always be qualified, it would be nice to provide a bit more control over the method name (including overriding that default behavior). Alternatively, the javadoc to document the status quo can be improved.

@snicoll snicoll added type: documentation A documentation task theme: aot An issue related to Ahead-of-time processing labels Aug 23, 2022
@snicoll snicoll added this to the 6.0.x milestone Aug 23, 2022
@philwebb philwebb self-assigned this Aug 23, 2022
@snicoll snicoll closed this as completed in 635534c Oct 7, 2022
@snicoll snicoll assigned snicoll and unassigned philwebb Oct 7, 2022
@snicoll snicoll modified the milestones: 6.0.x, 6.0.0-RC1 Oct 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: aot An issue related to Ahead-of-time processing type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

2 participants