pack-priv final Class SelectItemsIterator

true if the iteration has more elements

Annotations

@Override

initializeItems	back to summary
private void initializeItems(Object kid) Initializes the `items` instance variable with an `Iterator` appropriate to the UISelectItem(s) value.

next	back to summary
public SelectItem next() Implements java.util.Iterator.next. Return the next element in the iteration. Returns:SelectItem Doc from java.util.Iterator.next. the next element in the iteration Annotations @SuppressWarnings:unchecked @Override Exceptions NoSuchElementException: if there are no more elements

public SelectItem next()

Implements java.util.Iterator.next.

Return the next element in the iteration.

Returns:SelectItem

Doc from java.util.Iterator.next.

the next element in the iteration

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

NoSuchElementException:: if there are no more elements

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Throw UnsupportedOperationException. Annotations @Override

remove

public void remove()

Overrides default java.util.Iterator.remove.

Throw UnsupportedOperationException.

Annotations

@Override

updateSingeItemIterator back to summary

updateSingeItemIterator	back to summary
private void updateSingeItemIterator(SelectItem item) Update the `singleItemIterator` with the provided `item` Parameters item:SelectItem the `SelectItem` to expose as an Iterator

private void updateSingeItemIterator(SelectItem item)

Update the singleItemIterator with the provided item

Parameters

item:SelectItem: the SelectItem to expose as an Iterator

jakarta.faces.component back to summary

private final Class SelectItemsIterator.ArrayIterator

Class Inheritance

extends GenericObjectSelectItemIterator

java.lang.Object
jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator
jakarta.faces.component.SelectItemsIterator.ArrayIterator

Handles arrays of SelectItems, generic Objects, or combintations of both. A single GenericObjectSelectItem will be leverage for any non-SelectItem objects encountered.

Field Summary

Modifier and Type	Field and Description
private Object	array
private int	count
private FacesContext	ctx
private int	index

Inherited from jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator:: sourceComponent

Constructor Summary

Access	Constructor and Description
private	ArrayIterator(FacesContext ctx, UISelectItems sourceComponent, Object array)

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 SelectItem	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 jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator:: getSelectItemFor

Field Detail

array	back to summary
private Object array

count	back to summary
private int count

ctx	back to summary
private FacesContext ctx

index	back to summary
private int index

Constructor Detail

ArrayIterator	back to summary
private ArrayIterator(FacesContext ctx, UISelectItems sourceComponent, Object array)

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.

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 SelectItem next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:SelectItem the next element in the iteration Annotations @Override

public SelectItem next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:SelectItem

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.

jakarta.faces.component.SelectItemsIterator.ArrayIterator, jakarta.faces.component.SelectItemsIterator.IterableItemIterator

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

jakarta.faces.component back to summary

private abstract Class SelectItemsIterator.GenericObjectSelectItemIterator

Class Inheritance

extends Object
implements Iterator<SelectItem>

java.lang.Object
jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator

All Implemented Interfaces

java.util.Iterator

Known Direct Subclasses

Base class to support iterating over Collections or Arrays that may or may not contain SelectItem instances.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SelectItemsIterator.GenericObjectSelectItemIterator.GenericObjectSelectItem A `SelectItem` implementation to support generating unique `SelectItem` values based on `ValueExpressions` from the owning `UISelectItems` instance.

Field Summary

Modifier and Type	Field and Description
private SelectItemsIterator.GenericObjectSelectItemIterator.GenericObjectSelectItem	genericObjectSI SelectItem that is updated based on the current Object being iterated over.
protected UISelectItems	sourceComponent The source `UISelectItems`.

Constructor Summary

Access	Constructor and Description
protected	GenericObjectSelectItemIterator(UISelectItems sourceComponent)

Method Summary

Modifier and Type	Method and Description
protected SelectItem	getSelectItemFor(FacesContext ctx, Object value)

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

Field Detail

genericObjectSI	back to summary
private SelectItemsIterator.GenericObjectSelectItemIterator.GenericObjectSelectItem genericObjectSI SelectItem that is updated based on the current Object being iterated over.

sourceComponent	back to summary
protected UISelectItems sourceComponent The source `UISelectItems`.

Constructor Detail

GenericObjectSelectItemIterator	back to summary
protected GenericObjectSelectItemIterator(UISelectItems sourceComponent)

Method Detail

getSelectItemFor	back to summary
protected SelectItem getSelectItemFor(FacesContext ctx, Object value)

jakarta.faces.component back to summary

private final Class SelectItemsIterator.GenericObjectSelectItemIterator.GenericObjectSelectItem

Class Inheritance

extends SelectItem

java.lang.Object
jakarta.faces.model.SelectItem
jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator.GenericObjectSelectItem

Annotations

@SuppressWarnings:serial

A SelectItem implementation to support generating unique SelectItem values based on ValueExpressions from the owning UISelectItems instance.

Field Summary

Modifier and Type	Field and Description
private static final String	ITEM_DESCRIPTION
private static final String	ITEM_DISABLED
private static final String	ITEM_ESCAPED
private static final String	ITEM_LABEL
private static final String	ITEM_VALUE
private ValueExpression	itemDescription Resolves to the description of the `SelectItem`.
private ValueExpression	itemDisabled Determines the value for the disabled property of the `SelectItem`/
private ValueExpression	itemEscaped Determines the value for the escaped property of the `SelectItem`.
private ValueExpression	itemLabel Resolves to the label of the `SelectItem`.
private ValueExpression	itemValue Resolves to the value of the `SelectItem`.
private static final String	NO_SELECTION_OPTION
private ValueExpression	noSelectionOption Hides jakarta.faces.model.SelectItem.noSelectionOption. Determines the value for the noSelectionOption property of the `SelectItem`/
private UISelectItems	sourceComponent
private static final String	VAR
private String	var The request-scoped variable under which the current object will be exposed.

Constructor Summary

Access	Constructor and Description
private	GenericObjectSelectItem(UISelectItems sourceComponent)

Method Summary

Modifier and Type	Method and Description
private void	readObject(ObjectInputStream in)
private void	updateItem(FacesContext the `FacesContext` for the current request ctx, Object the value to build the updated values from value) Updates the `SelectItem` properties based on the current value.
private void	writeObject(ObjectOutputStream out)

Inherited from jakarta.faces.model.SelectItem:: getDescription getLabel getValue isDisabled isEscape isNoSelectionOption setDescription setDisabled setEscape setLabel setNoSelectionOption setValue

Field Detail

ITEM_DESCRIPTION	back to summary
private static final String ITEM_DESCRIPTION

ITEM_DISABLED	back to summary
private static final String ITEM_DISABLED

ITEM_ESCAPED	back to summary
private static final String ITEM_ESCAPED

ITEM_LABEL	back to summary
private static final String ITEM_LABEL

ITEM_VALUE	back to summary
private static final String ITEM_VALUE

itemDescription	back to summary
private ValueExpression itemDescription Resolves to the description of the `SelectItem`.

itemDisabled	back to summary
private ValueExpression itemDisabled Determines the value for the disabled property of the `SelectItem`/

itemEscaped	back to summary
private ValueExpression itemEscaped Determines the value for the escaped property of the `SelectItem`.

itemLabel	back to summary
private ValueExpression itemLabel Resolves to the label of the `SelectItem`.

itemValue	back to summary
private ValueExpression itemValue Resolves to the value of the `SelectItem`.

NO_SELECTION_OPTION	back to summary
private static final String NO_SELECTION_OPTION

noSelectionOption back to summary

noSelectionOption	back to summary
private ValueExpression noSelectionOption Hides jakarta.faces.model.SelectItem.noSelectionOption. Determines the value for the noSelectionOption property of the `SelectItem`/

private ValueExpression noSelectionOption

Hides jakarta.faces.model.SelectItem.noSelectionOption.

Determines the value for the noSelectionOption property of the SelectItem/

sourceComponent	back to summary
private UISelectItems sourceComponent

VAR	back to summary
private static final String VAR

var	back to summary
private String var The request-scoped variable under which the current object will be exposed.

Constructor Detail

GenericObjectSelectItem	back to summary
private GenericObjectSelectItem(UISelectItems sourceComponent)

Method Detail

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException

updateItem back to summary

private void updateItem(FacesContext ctx, Object value)

Updates the SelectItem properties based on the current value.

Parameters

ctx:FacesContext: the FacesContext for the current request
value:Object: the value to build the updated values from

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException

jakarta.faces.component back to summary

private final Class SelectItemsIterator.IterableItemIterator

Class Inheritance

extends GenericObjectSelectItemIterator

java.lang.Object
jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator
jakarta.faces.component.SelectItemsIterator.IterableItemIterator

Handles Collections of SelectItems, generic Objects, or combintations of both. A single GenericObjectSelectItem will be leverage for any non-SelectItem objects encountered.

Field Summary

Modifier and Type	Field and Description
private FacesContext	ctx
private Iterator<?>	iterator

Inherited from jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator:: sourceComponent

Constructor Summary

Access	Constructor and Description
private	IterableItemIterator(FacesContext ctx, UISelectItems sourceComponent, Iterable<?> iterable)

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 SelectItem	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 jakarta.faces.component.SelectItemsIterator.GenericObjectSelectItemIterator:: getSelectItemFor

Field Detail

ctx	back to summary
private FacesContext ctx

iterator	back to summary
private Iterator<?> iterator

Constructor Detail

IterableItemIterator	back to summary
private IterableItemIterator(FacesContext ctx, UISelectItems sourceComponent, Iterable<?> iterable)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements 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 SelectItem next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:SelectItem

the next element in the iteration

Annotations

@Override

remove back to summary

public void remove()

Overrides default 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 this method is called after a call to the forEachRemaining method.

Annotations

@Override

jakarta.faces.component back to summary

private final Class SelectItemsIterator.MapIterator

Class Inheritance

extends Object
implements Iterator<SelectItem>

java.lang.Object
jakarta.faces.component.SelectItemsIterator.MapIterator

All Implemented Interfaces

java.util.Iterator

Iterates over a Map of values exposing each entry as a SelectItem. Note that this will do so re-using the same SelectItem but changing the value and label as appropriate.

Field Summary

Modifier and Type	Field and Description
private SelectItem	item
private Iterator<E>	iterator

Constructor Summary

Access	Constructor and Description
private	MapIterator(Map<K, V> map)

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 SelectItem	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

item	back to summary
private SelectItem item

iterator	back to summary
private Iterator<E> iterator

Constructor Detail

MapIterator	back to summary
private MapIterator(Map<K, V> map)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements 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 SelectItem next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:SelectItem

the next element in the iteration

Annotations

@Override

remove back to summary

public void remove()

Overrides default 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 this method is called after a call to the forEachRemaining method.

Annotations

@Override

jakarta.faces.component back to summary

private final Class SelectItemsIterator.SingleElementIterator

Class Inheritance

extends Object
implements Iterator<SelectItem>

java.lang.Object
jakarta.faces.component.SelectItemsIterator.SingleElementIterator

All Implemented Interfaces

java.util.Iterator

Exposes single SelectItem instances as an Iterator.

Field Summary

Modifier and Type	Field and Description
private SelectItem	item
private boolean	nextCalled

Constructor Summary

Access	Constructor and Description
private	SingleElementIterator()

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 SelectItem	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).
private void	updateItem(SelectItem item)

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

Field Detail

item	back to summary
private SelectItem item

nextCalled	back to summary
private boolean nextCalled

Constructor Detail

SingleElementIterator	back to summary
private SingleElementIterator()

Method Detail

hasNext back to summary

public boolean hasNext()

Implements 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 SelectItem next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:SelectItem

the next element in the iteration

Annotations

@Override

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.