org.jdesktop.dom.SimpleNodeList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swingx-ws Show documentation
Set of utilities and widgets to simplify interaction of Swing based GUIs with the web applications of any kind.
The newest version!
/*
 * $Id: SimpleNodeList.java 134 2006-12-19 18:39:48Z rbair $
 *
 * Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
 * Santa Clara, California 95054, U.S.A. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.jdesktop.dom;

import java.util.Iterator;
import java.util.List;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * An implementation of {@link org.w3c.dom.NodeList} which also implements
 * {@link Iterable}. This allows you to use a SimpleNodeList in an enhanced
 * for loop, such as:
 * 

 *  SimpleNodeList nodes = ...;
 *  for (Node n : nodes) {
 *      System.out.println(n.getTextContent());
 *  }
 * 

 * 
 * SimpleNodeList wraps a source NodeList. Thus, any NodeList can be adapted
 * for use with enhanced for loops by wrapping it in a SimpleNodeList.
 * 
 * @author rbair
 */
public class SimpleNodeList implements NodeList, Iterable {
    private NodeList list;
    
    /** 
     * Creates a new instance of SimpleNodeList.
     * 
     * @param list the NodeList to wrap.
     */
    public SimpleNodeList(NodeList list) {
        if (list == null) {
            throw new NullPointerException();
        }
        this.list = list;
    }

    /**
     * Create a new SimpleNodeList that wraps the given nodes
     *
     * @param nodes the nodes to wrap
     */
    public SimpleNodeList(List nodes) {
        this(nodes.toArray(new Node[0]));
    }
    
    /**
     * Create a new SimpleNodeList that wraps the given nodes
     *
     * @param nodes the nodes to wrap
     */
    public SimpleNodeList(Node... nodes) {
        final Node[] n = new Node[nodes == null ? 0 : nodes.length];
        System.arraycopy(nodes, 0, n, 0, n.length);
        this.list = new NodeList() {
            public int getLength() {
                return n.length;
            }
            public Node item(int index) {
                return n[index];
            }
        };
    }
    
    /**
     * @inheritDoc
     */
    public Node item(int index) {
        return list.item(index);
    }

    /**
     * @inheritDoc
     */
    public int getLength() {
        return list.getLength();
    }

    /**
     * @inheritDoc
     */
    public Iterator iterator() {
        return new Iterator() {
            int index = 0;
            
            public boolean hasNext() {
                return index < getLength();
            }

            public Node next() {
                return item(index++);
            }

            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
    }
}