Modifier and Type	Class and Description
private class	PartialVisitContext.CollectionProxy<E extends String>
private class	PartialVisitContext.IteratorProxy<E extends String>

Modifier and Type	Field and Description
private Collection<String>	clientIds
private FacesContext	facesContext
private Set<VisitHint>	hints
private Collection<String>	ids
private Map<String, Collection<String>>	subtreeClientIds
private Collection<String>	unvisitedClientIds

Access	Constructor and Description
public	PartialVisitContext(FacesContext the FacesContext for the current request facesContext, Collection<String> the client ids of the components to visit clientIds) Creates a PartialVisitorContext instance.
public	PartialVisitContext(FacesContext the FacesContext for the current request facesContext, Collection<String> the client ids of the components to visit clientIds, Set<VisitHint> a the VisitHints for this visit hints) Creates a PartialVisitorContext instance with the specified hints.

Method Summary

Modifier and Type	Method and Description
private void	addSubtreeClientId(String clientId)
public FacesContext	getFacesContext() Implements abstract javax.faces.component.visit.VisitContext.getFacesContext. Returns the FacesContext for the current request.
public Set<VisitHint>	getHints() Implements abstract javax.faces.component.visit.VisitContext.getHints. Returns hints that influence the behavior of the tree visit.
private String	getIdFromClientId(String clientId)
public Collection<String>	getIdsToVisit() Implements abstract javax.faces.component.visit.VisitContext.getIdsToVisit. Returns the ids of the components to visit.
public Collection<String>	getSubtreeIdsToVisit(UIComponent a NamingContainer component component) Implements abstract javax.faces.component.visit.VisitContext.getSubtreeIdsToVisit. Given a `javax.faces.component.NamingContainer` component, returns the client ids of any components underneath the NamingContainer that should be visited.
public Collection<String>	getUnvisitedClientIds()
private String	getVisitId(UIComponent component)
private void	idAdded(String clientId)
private void	idRemoved(String clientId)
private void	initializeCollections(Collection<String> clientIds)
public VisitResult	invokeVisitCallback(UIComponent the component to visit component, VisitCallback the VisitCallback to call callback) Implements abstract javax.faces.component.visit.VisitContext.invokeVisitCallback. Called by `UIComponent.visitTree()` to visit a single component.
private void	removeSubtreeClientId(String clientId)

Inherited from javax.faces.component.visit.VisitContext:: createVisitContext createVisitContext

Field Detail

clientIds	back to summary
private Collection<String> clientIds

facesContext	back to summary
private FacesContext facesContext

hints	back to summary
private Set<VisitHint> hints

ids	back to summary
private Collection<String> ids

subtreeClientIds	back to summary
private Map<String, Collection<String>> subtreeClientIds

unvisitedClientIds	back to summary
private Collection<String> unvisitedClientIds

Constructor Detail

PartialVisitContext back to summary

PartialVisitContext	back to summary
public PartialVisitContext(FacesContext facesContext, Collection<String> clientIds) Creates a PartialVisitorContext instance. Parameters facesContext:FacesContext the FacesContext for the current request clientIds:Collection<String> the client ids of the components to visit Exceptions NullPointerException: if `facesContext` is `null`

public PartialVisitContext(FacesContext facesContext, Collection<String> clientIds)

Creates a PartialVisitorContext instance.

Parameters

facesContext:FacesContext: the FacesContext for the current request
clientIds:Collection<String>: the client ids of the components to visit

Exceptions

NullPointerException:: if facesContext is null

PartialVisitContext back to summary

PartialVisitContext	back to summary
public PartialVisitContext(FacesContext facesContext, Collection<String> clientIds, Set<VisitHint> hints) Creates a PartialVisitorContext instance with the specified hints. Parameters facesContext:FacesContext the FacesContext for the current request clientIds:Collection<String> the client ids of the components to visit hints:Set<VisitHint> a the VisitHints for this visit Exceptions NullPointerException: if `facesContext` is `null`

public PartialVisitContext(FacesContext facesContext, Collection<String> clientIds, Set<VisitHint> hints)

Creates a PartialVisitorContext instance with the specified hints.

Parameters

facesContext:FacesContext: the FacesContext for the current request
clientIds:Collection<String>: the client ids of the components to visit
hints:Set<VisitHint>: a the VisitHints for this visit

Exceptions

NullPointerException:: if facesContext is null

Method Detail

addSubtreeClientId	back to summary
private void addSubtreeClientId(String clientId)

getFacesContext back to summary

getFacesContext	back to summary
public FacesContext getFacesContext() Implements abstract javax.faces.component.visit.VisitContext.getFacesContext. Doc from javax.faces.component.visit.VisitContext.getFacesContext. Returns the FacesContext for the current request. Returns:FacesContext the FacesContext. Annotations @Override See Also `VisitContext.getFacesContext()`

public FacesContext getFacesContext()

Implements abstract javax.faces.component.visit.VisitContext.getFacesContext.

Doc from javax.faces.component.visit.VisitContext.getFacesContext.

Returns the FacesContext for the current request.

Returns:FacesContext

the FacesContext.

Annotations

@Override

See Also

VisitContext.getFacesContext()

getHints back to summary

getHints	back to summary
public Set<VisitHint> getHints() Implements abstract javax.faces.component.visit.VisitContext.getHints. Doc from javax.faces.component.visit.VisitContext.getHints. Returns hints that influence the behavior of the tree visit. Interested parties, such as `UIComponent.visitTree()` implementations, may check to see whether a particular hint is present by calling `VisitContext.getHints().contains()`, passing in one of the hints defined by `VisitHint`. Returns:Set<VisitHint> a non-empty, unmodifiable collection of VisitHints Annotations @Override See Also `VisitContext.getHints`

public Set<VisitHint> getHints()

Implements abstract javax.faces.component.visit.VisitContext.getHints.

Doc from javax.faces.component.visit.VisitContext.getHints.

Returns hints that influence the behavior of the tree visit.

Interested parties, such as UIComponent.visitTree() implementations, may check to see whether a particular hint is present by calling VisitContext.getHints().contains(), passing in one of the hints defined by VisitHint.

Returns:Set<VisitHint>

a non-empty, unmodifiable collection of VisitHints

Annotations

@Override

See Also

VisitContext.getHints

getIdFromClientId	back to summary
private String getIdFromClientId(String clientId)

getIdsToVisit back to summary

getIdsToVisit	back to summary
public Collection<String> getIdsToVisit() Implements abstract javax.faces.component.visit.VisitContext.getIdsToVisit. Doc from javax.faces.component.visit.VisitContext.getIdsToVisit. Returns the ids of the components to visit. In the case of a full tree visit, this method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a modifiable collection containing the client ids of the components that should be visited. Returns:Collection<String> the ids of the components to visit Annotations @Override See Also `VisitContext.getIdsToVisit()`

public Collection<String> getIdsToVisit()

Implements abstract javax.faces.component.visit.VisitContext.getIdsToVisit.

Doc from javax.faces.component.visit.VisitContext.getIdsToVisit.

Returns the ids of the components to visit.

In the case of a full tree visit, this method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a modifiable collection containing the client ids of the components that should be visited.

Returns:Collection<String>

the ids of the components to visit

Annotations

@Override

See Also

VisitContext.getIdsToVisit()

getSubtreeIdsToVisit back to summary

getSubtreeIdsToVisit	back to summary
public Collection<String> getSubtreeIdsToVisit(UIComponent component) Implements abstract javax.faces.component.visit.VisitContext.getSubtreeIdsToVisit. Doc from javax.faces.component.visit.VisitContext.getSubtreeIdsToVisit. Given a `javax.faces.component.NamingContainer` component, returns the client ids of any components underneath the NamingContainer that should be visited. This method is called by NamingContainer visitTree() implementations to determine whether the NamingContainer contains components to be visited. In the case where no such components exist, the NamingContainer can short-circuit the tree visit and avoid descending into child subtrees. In addition, iterating components such as UIData may be able to use the returned ids to determine which iterated states (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those rows that contain visit targets need to be traversed. Parameters component:UIComponent a NamingContainer component Returns:Collection<String> an unmodifiable Collection containing the client ids of any components underneath the NamingContainer that are known to be targets of the tree visit. If no such components exist, returns an empty Collection. If all components underneath the NamingContainer should be visited, returns the `VisitContext.ALL_IDS` collection. Annotations @Override See Also `VisitContext.getSubtreeIdsToVisit()`

public Collection<String> getSubtreeIdsToVisit(UIComponent component)

Implements abstract javax.faces.component.visit.VisitContext.getSubtreeIdsToVisit.

Doc from javax.faces.component.visit.VisitContext.getSubtreeIdsToVisit.

Given a javax.faces.component.NamingContainer component, returns the client ids of any components underneath the NamingContainer that should be visited.

This method is called by NamingContainer visitTree() implementations to determine whether the NamingContainer contains components to be visited. In the case where no such components exist, the NamingContainer can short-circuit the tree visit and avoid descending into child subtrees.

In addition, iterating components such as UIData may be able to use the returned ids to determine which iterated states (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those rows that contain visit targets need to be traversed.

Parameters

component:UIComponent: a NamingContainer component

Returns:Collection<String>

an unmodifiable Collection containing the client ids of any components underneath the NamingContainer that are known to be targets of the tree visit. If no such components exist, returns an empty Collection. If all components underneath the NamingContainer should be visited, returns the VisitContext.ALL_IDS collection.

Annotations

@Override

See Also

VisitContext.getSubtreeIdsToVisit()

getUnvisitedClientIds	back to summary
public Collection<String> getUnvisitedClientIds()

getVisitId	back to summary
private String getVisitId(UIComponent component)

idAdded	back to summary
private void idAdded(String clientId)

idRemoved	back to summary
private void idRemoved(String clientId)

initializeCollections	back to summary
private void initializeCollections(Collection<String> clientIds)

invokeVisitCallback back to summary

invokeVisitCallback	back to summary
public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback) Implements abstract javax.faces.component.visit.VisitContext.invokeVisitCallback. Doc from javax.faces.component.visit.VisitContext.invokeVisitCallback. Called by `UIComponent.visitTree()` to visit a single component. Parameters component:UIComponent the component to visit callback:VisitCallback the VisitCallback to call Returns:VisitResult a VisitResult value that indicates whether to continue visiting the component's subtree, skip visiting the component's subtree or abort the visit altogether. Annotations @Override See Also `VisitContext.invokeVisitCallback()`

public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback)

Implements abstract javax.faces.component.visit.VisitContext.invokeVisitCallback.

Doc from javax.faces.component.visit.VisitContext.invokeVisitCallback.

Called by UIComponent.visitTree() to visit a single component.

Parameters

component:UIComponent: the component to visit
callback:VisitCallback: the VisitCallback to call

Returns:VisitResult

a VisitResult value that indicates whether to continue visiting the component's subtree, skip visiting the component's subtree or abort the visit altogether.

Annotations

@Override

See Also

VisitContext.invokeVisitCallback()

removeSubtreeClientId	back to summary
private void removeSubtreeClientId(String clientId)

com.sun.faces.component.visit back to summary

private Class PartialVisitContext.CollectionProxy<E extends java.lang.String>

Class Inheritance

extends AbstractCollection<E extends String>

java.lang.Object
java.util.AbstractCollection
com.sun.faces.component.visit.PartialVisitContext.CollectionProxy

Field Summary

Modifier and Type	Field and Description
private Collection<E>	wrapped

Constructor Summary

Access	Constructor and Description
private	CollectionProxy(Collection<E> wrapped)

Method Summary

Modifier and Type	Method and Description
public boolean	add(E element whose presence in this collection is to be ensured o) Overrides java.util.AbstractCollection.add. Implements java.util.Collection.add. Ensures that this collection contains the specified element (optional operation).
public Iterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Returns an iterator over the elements contained in this collection.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Collection.size. Returns the number of elements in this collection.

Inherited from java.util.AbstractCollection:: addAll clear contains containsAll isEmpty remove removeAll retainAll toArray toArray toString

Field Detail

wrapped	back to summary
private Collection<E> wrapped

Constructor Detail

CollectionProxy	back to summary
private CollectionProxy(Collection<E> wrapped)

Method Detail

add back to summary

add	back to summary
public boolean add(E o) Overrides java.util.AbstractCollection.add. Implements java.util.Collection.add. Doc from java.util.AbstractCollection.add. Ensures that this collection contains the specified element (optional operation). Returns `true` if this collection changed as a result of the call. (Returns `false` if this collection does not permit duplicates and already contains the specified element.) Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add `null` elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added. If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning `false`). This preserves the invariant that a collection always contains the specified element after this call returns. Parameters o:E Doc from java.util.Collection.add. element whose presence in this collection is to be ensured Returns:boolean Doc from java.util.Collection.add. `true` if this collection changed as a result of the call Annotations @Override

public boolean add(E o)

Overrides java.util.AbstractCollection.add.

Implements java.util.Collection.add.

Doc from java.util.AbstractCollection.add.

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Parameters

o:E

Doc from java.util.Collection.add.

element whose presence in this collection is to be ensured

Returns:boolean

Doc from java.util.Collection.add.

true if this collection changed as a result of the call

Annotations

@Override

iterator	back to summary
public Iterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Collection.iterator. Doc from java.util.AbstractCollection.iterator. Returns an iterator over the elements contained in this collection. Returns:Iterator<E> an iterator over the elements contained in this collection Annotations @Override

iterator

back to summary

public Iterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Collection.iterator.

Doc from java.util.AbstractCollection.iterator.

Returns an iterator over the elements contained in this collection.

Returns:Iterator<E>

an iterator over the elements contained in this collection

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Collection.size. Doc from java.util.Collection.size. Returns the number of elements in this collection. If this collection contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this collection Annotations @Override

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Collection.size.

Doc from java.util.Collection.size.

Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this collection

Annotations

@Override

com.sun.faces.component.visit back to summary

private Class PartialVisitContext.IteratorProxy<E extends java.lang.String>

Class Inheritance

extends Object
implements Iterator<E extends String>

java.lang.Object
com.sun.faces.component.visit.PartialVisitContext.IteratorProxy

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private E	current
private Iterator<E>	wrapped

Constructor Summary

Access	Constructor and Description
private	IteratorProxy(Iterator<E> wrapped)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public E	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

current	back to summary
private E current

wrapped	back to summary
private Iterator<E> wrapped

Constructor Detail

IteratorProxy	back to summary
private IteratorProxy(Iterator<E> wrapped)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public E next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:E the next element in the iteration Annotations @Override

back to summary

public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class PartialVisitContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PartialVisitContext.CollectionProxy<E extends java.lang.String>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PartialVisitContext.IteratorProxy<E extends java.lang.String>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail