com.google.gwt.dom.client.NodeList Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gwt-mock-2.5.1 Show documentation

A mocked implementation for GWT-2.5.1 that can run in the JVM to allow integration testing

The newest version!

/*
 * Copyright 2008 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.gwt.dom.client;

import java.util.Iterator;
import java.util.List;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * The NodeList interface provides the abstraction of an ordered collection of
 * nodes, without defining or constraining how this collection is implemented.
 * NodeList objects in the DOM are live.
 * 
 * The items in the NodeList are accessible via an integral index, starting from
 * 0.
 * 
 * @param 
 *            the type of contained node
 */
public class NodeList extends JavaScriptObject implements Iterable {

	private List list;

	public NodeList(List list) {
		this.list = list;
	}

	/**
	 * Returns the indexth item in the collection. If index is greater than or
	 * equal to the number of nodes in the list, this returns null.
	 * 
	 * @param index
	 *            Index into the collection
	 * @return the node at the indexth position in the NodeList, or null if that
	 *         is not a valid index.
	 */
	public final T getItem(int index) {
		return list.get(index);
	}

	/**
	 * The number of nodes in the list. The range of valid child node indices is
	 * 0 to length-1 inclusive.
	 */
	public final int getLength() {
		return list.size();
	}

	@Override
	public Iterator iterator() {
		return list.iterator();
	}
	
	public List getList() {
		return list;
	}
}