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

Specify the various Scope subtype's lifecycle in their Javadoc #13496

Closed
24 tasks done
lukaseder opened this issue Apr 27, 2022 · 0 comments
Closed
24 tasks done

Specify the various Scope subtype's lifecycle in their Javadoc #13496

lukaseder opened this issue Apr 27, 2022 · 0 comments
Labels
C: Documentation E: All Editions P: Medium R: Fixed T: Enhancement
Milestone
Version 3.17.0

Comments

@lukaseder
Copy link
Member

lukaseder commented Apr 27, 2022 •
edited
Loading

By now, we have numerous Scope types in our API. They all have a different lifecycle, and thus a different meaning of:

In order to have predictable behaviour in implementations and when interacting with those scopes, we should clearly specify their lifecycles in the relevant Javadocs.

The list will be amended:

  • BindingScope (see Add BindingScope, a common super type of the various BindingXYZContext types #13497)
    • BindingSQLContext
    • BindingGetResultSetContext
    • BindingGetSQLInputContext
    • BindingGetStatementContext
    • BindingRegisterContext
    • BindingSetSQLOutputContext
    • BindingSetStatementContext
  • CacheContext
  • Context
    • BindContext
    • RenderContext
  • DSLContext
    • CloseableDSLContext
  • ExecuteContext
  • ExecuteScope
  • GeneratorContext
  • Meta
  • Migration
  • ParseContext
  • RecordContext
  • ResourceManagingScope
  • TransactionContext
  • VisitContext
@lukaseder lukaseder added this to the Version 3.17.0 milestone Apr 27, 2022
lukaseder added a commit that referenced this issue Apr 27, 2022
@lukaseder
[#13496] Improve Scope Javadoc
eac8574
@lukaseder lukaseder mentioned this issue Apr 27, 2022
Closed
lukaseder added a commit that referenced this issue Apr 27, 2022
@lukaseder
[#13496] Specify BindingScope lifecycle in Javadoc
fb61cdb
lukaseder added a commit that referenced this issue Apr 27, 2022
@lukaseder
[#13496] Specify CacheContext lifecycle in Javadoc
80ff2e3
lukaseder added a commit that referenced this issue Apr 27, 2022
@lukaseder
[#13496] Specify the Scope subtype lifecycles in their Javadoc
eba5c5b 
- Context
- DSLContext
- ExecuteContext
- GeneratorContext
- Meta
- Migration
- MigrationContext
- RecordContext
- ResourceManagingScope
- TransactionContext
- VisitContext
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C: Documentation E: All Editions P: Medium R: Fixed T: Enhancement
Projects
None yet
Milestone
Version 3.17.0
Development

No branches or pull requests
1 participant
@lukaseder