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 on QueryDslPredicateExecutor [DATACMNS-577] #1044

Closed
spring-projects-issues opened this issue Oct 3, 2014 · 2 comments
Closed
Assignees
Labels
type: documentation type: enhancement

Comments

@spring-projects-issues
Copy link

spring-projects-issues commented Oct 3, 2014

Lovro Pandžić opened DATACMNS-577 and commented

Methods in the QueryDslPredicateExecutor should be better documented.
For example:

  • findOne - what happens if it finds more than one result and what happens if it does not find any - does it return a null or does it throw an exception?
  • findAll - how can it fail, can it return a null?

Fix params that are missing description.

Otherwise this causes possibly unneeded null checks and exception checks in the client code because clients can't know what to expect. This might also be applied to other repository interface definitions


Affects: 1.9 GA (Evans)

Referenced from: pull request #96

Backported to: 1.9.1 (Evans SR1), 1.8.5 (Dijkstra SR5)

@spring-projects-issues
Copy link
Author

spring-projects-issues commented Oct 6, 2014

Thomas Darimont commented

Please revise

@spring-projects-issues
Copy link
Author

spring-projects-issues commented Oct 7, 2014

Oliver Drotbohm commented

See the minor comments on the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation type: enhancement
Projects
None yet
Development

No branches or pull requests

2 participants