javax.faces.model.ListDataModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces-api Show documentation
Show all versions of jakarta.faces-api Show documentation
Jakarta Faces defines an MVC framework for building user interfaces for web applications,
including UI components, state management, event handing, input validation, page navigation, and
support for internationalization and accessibility.
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.faces.model;
import java.util.List;
/**
* ListDataModel is a convenience implementation of
* {@link DataModel} that wraps an List of Java objects.
*/
public class ListDataModel extends DataModel {
// ------------------------------------------------------------ Constructors
/**
* Construct a new {@link ListDataModel} with no specified
* wrapped data.
*/
public ListDataModel() {
this(null);
}
/**
* Construct a new {@link ListDataModel} wrapping the specified
* list.
*
* @param list List to be wrapped (if any)
*/
public ListDataModel(List list) {
super();
setWrappedData(list);
}
// ------------------------------------------------------ Instance Variables
// The current row index (zero relative)
private int index = -1;
// The list we are wrapping
private List list;
// -------------------------------------------------------------- Properties
/**
* 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.
*
* @throws javax.faces.FacesException if an error occurs getting the row availability
*/
@Override
public boolean isRowAvailable() {
if (list == null) {
return (false);
} else if ((index >= 0) && (index < list.size())) {
return (true);
} else {
return (false);
}
}
/**
* If there is wrappedData available, return the
* length of the list. If no wrappedData is available,
* return -1.
*
* @throws javax.faces.FacesException if an error occurs getting the row count
*/
@Override
public int getRowCount() {
if (list == null) {
return (-1);
}
return (list.size());
}
/**
* If row data is available, return the array element at the index
* specified by rowIndex. If no wrapped data is available,
* return null.
*
* @throws javax.faces.FacesException if an error occurs getting the row data
* @throws IllegalArgumentException if now row data is available
* at the currently specified row index
*/
@Override
public E getRowData() {
if (list == null) {
return (null);
} else if (!isRowAvailable()) {
throw new NoRowAvailableException();
} else {
return ((E) list.get(index));
}
}
/**
* @throws javax.faces.FacesException {@inheritDoc}
*/
@Override
public int getRowIndex() {
return (index);
}
/**
* @throws javax.faces.FacesException {@inheritDoc}
* @throws IllegalArgumentException {@inheritDoc}
*/
@Override
public void setRowIndex(int rowIndex) {
if (rowIndex < -1) {
throw new IllegalArgumentException();
}
int old = index;
index = rowIndex;
if (list == null) {
return;
}
DataModelListener [] listeners = getDataModelListeners();
if ((old != index) && (listeners != null)) {
Object rowData = null;
if (isRowAvailable()) {
rowData = getRowData();
}
DataModelEvent event =
new DataModelEvent(this, index, rowData);
int n = listeners.length;
for (int i = 0; i < n; i++) {
if (null != listeners[i]) {
listeners[i].rowSelected(event);
}
}
}
}
@Override
public Object getWrappedData() {
return (this.list);
}
/**
* @throws ClassCastException if data is
* non-null and is not a List
*/
@Override
public void setWrappedData(Object data) {
if (data == null) {
list = null;
setRowIndex(-1);
} else {
list = (List) data;
index = -1;
setRowIndex(0);
}
}
}