Skip to content

Fix #2214: document that UIData row iteration during a tree visit is observable #2216

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

Open
BalusC wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Open

Fix #2214: document that UIData row iteration during a tree visit is observable #2216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion api/src/main/java/jakarta/faces/component/UIData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1328,7 +1328,9 @@ public String createUniqueId(FacesContext context, String seed) {
* </p>
*
* <p>
* Iterate over the rows.
* Iterate over the rows. <span class="changed_added_5_0">The rows are only iterated over when
* {@link VisitHint#SKIP_ITERATION} is absent from the hints of the given {@link VisitContext}. When it is present,
* the children are instead visited once at the current row index, without the row index being manipulated.</span>
* </p>
*
* </div>
Expand Down
7 changes: 7 additions & 0 deletions api/src/main/java/jakarta/faces/component/visit/VisitHint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ public enum VisitHint {
* iterative fashion should instead visit each child only one time.
* </p>
*
* <p class="changed_added_5_0">
* Visiting children repeatedly is not transparent to those children: each of them is visited once per row with the
* row index set to that row, and may respond to it, for example by loading the data of that row from the backing
* data source. This hint is therefore appropriate when the traversal only needs to locate or inspect components,
* and inappropriate when the traversal needs to act per row, as decoding, validating, updating and rendering do.
* </p>
*
* @since 2.1
*/
SKIP_ITERATION,
Expand Down
3 changes: 3 additions & 0 deletions spec/src/main/asciidoc/ChangeLog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ pre-Jakarta Faces specification under the JCP.

This release contains the following backwards compatible changes:

* Issue ID {issue_tracker_url}2214[2214] +
Spec: clarify UIData row iteration during tree visits

* Issue ID {issue_tracker_url}2173[2173] +
Change: generalize Render Response resource push to allow modern mechanisms such as HTTP 103 Early Hints

Expand Down
6 changes: 3 additions & 3 deletions spec/src/main/asciidoc/UserInterfaceComponentModel.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,9 +390,9 @@ public boolean visitTree(VisitContext context, VisitCallback callback);

Uses the visit API introduced in version 2 of
the specification to perform a flexible and customizable visit of the
tree from this instance and its children. Please see the package
description for the package _jakarta.faces.component.visit_ for the
normative specification.
tree from this instance and its children. Please see the javadocs for
_UIComponent.visitTree()_ and _jakarta.faces.component.visit.VisitContext_
for the normative specification.

[[a968]]
==== Facet Management
Expand Down
Loading