Module jakarta.faces

Package jakarta.faces.model

Class CollectionDataModel<E>

java.lang.Object

jakarta.faces.model.DataModel<E>

jakarta.faces.model.CollectionDataModel<E>

All Implemented Interfaces:

Iterable<E>

public class CollectionDataModel<E>
extends DataModel<E>

CollectionDataModel is a convenience implementation of DataModel that wraps an Collection of Java objects.

Constructor Summary

Constructors

Constructor	Description
CollectionDataModel()	Construct a new CollectionDataModel with no specified wrapped data.
CollectionDataModel(Collection<E> collection)	Construct a new CollectionDataModel wrapping the specified list.

Method Summary

Modifier and Type	Method	Description
int	getRowCount()	If there is wrappedData available, return the length of the list.
E	getRowData()	If row data is available, return the array element at the index specified by rowIndex.
int	getRowIndex()	Return the zero-relative index of the currently selected row.
Object	getWrappedData()	Return the object representing the data wrapped by this DataModel, if any.
boolean	isRowAvailable()	Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list.
void	setRowIndex(int rowIndex)	Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.
void	setWrappedData(Object data)	Set the wrapped data.

Methods inherited from class jakarta.faces.model.DataModel

addDataModelListener, getDataModelListeners, iterator, removeDataModelListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CollectionDataModel

public CollectionDataModel()

Construct a new CollectionDataModel with no specified wrapped data.

CollectionDataModel

public CollectionDataModel(Collection<E> collection)

Construct a new CollectionDataModel wrapping the specified list.

Parameters:

collection - Collection to be wrapped.

Method Details

isRowAvailable

public boolean isRowAvailable()

Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list. Otherwise, return false.

Specified by:

isRowAvailable in class DataModel<E>

Returns:

true if and only if there is data available at the current index, false otherwise.

Throws:

FacesException - if an error occurs getting the row availability

getRowCount

public int getRowCount()

If there is wrappedData available, return the length of the list. If no wrappedData is available, return -1.

Specified by:

getRowCount in class DataModel<E>

Returns:

the number of rows of data represented by this DataModel

Throws:

FacesException - if an error occurs getting the row count

getRowData

public E getRowData()

If row data is available, return the array element at the index specified by rowIndex. If no wrapped data is available, return null.

Specified by:

getRowData in class DataModel<E>

Returns:

an object representing the data for the currently selected row index

Throws:

FacesException - if an error occurs getting the row data

IllegalArgumentException - if now row data is available at the currently specified row index

getRowIndex

public int getRowIndex()

Description copied from class: DataModel

Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1.

Specified by:

getRowIndex in class DataModel<E>

Returns:

the index of the currently selected row

Throws:

FacesException - if an error occurs getting the row index

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from class: DataModel

Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method.

If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners.

Specified by:

setRowIndex in class DataModel<E>

Parameters:

rowIndex - The new zero-relative index (must be non-negative)

Throws:

FacesException - if an error occurs setting the row index

IllegalArgumentException - if rowIndex is less than -1

getWrappedData

public Object getWrappedData()

Description copied from class: DataModel

Return the object representing the data wrapped by this DataModel, if any.

Specified by:

getWrappedData in class DataModel<E>

Returns:

the Object that this model wraps.

setWrappedData

public void setWrappedData(Object data)

Set the wrapped data.

Specified by:

setWrappedData in class DataModel<E>

Parameters:

data - the wrapped data.

Throws:

ClassCastException - if data is non-null and is not a Collection