All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.model.ListDataModel Maven / Gradle / Ivy

Go to download

This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.

There is a newer version: 2.2.20
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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 */ 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 */ 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 */ 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} */ public int getRowIndex() { return (index); } /** * @throws javax.faces.FacesException {@inheritDoc} * @throws IllegalArgumentException {@inheritDoc} */ 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); } } } } public Object getWrappedData() { return (this.list); } /** * @throws ClassCastException if data is * non-null and is not a List */ public void setWrappedData(Object data) { if (data == null) { list = null; setRowIndex(-1); } else { list = (List) data; index = -1; setRowIndex(0); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy