org.jfree.util.ObjectList Maven / Gradle / Ivy
Show all versions of jcommon Show documentation
/* ========================================================================
* JCommon : a free general purpose class library for the Java(tm) platform
* ========================================================================
*
* (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jcommon/index.html
*
* 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 Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
* ---------------
* ObjectList.java
* ---------------
* (C)opyright 2003, 2004, by Object Refinery Limited and Contributors.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* $Id: ObjectList.java,v 1.6 2005/11/14 10:56:42 mungady Exp $
*
* Changes
* -------
* 17-Jul-2003 : Version 1 (DG);
* 13-Aug-2003 : Refactored to extend AbstractObjectList (DG);
* 21-Oct-2004 : removed duplicate interface declarations and empty methods.
* 22-Oct-2004 : Restored removed methods - see note in code (DG);
*
*/
package org.jfree.util;
/**
* A list of objects that can grow as required.
*
* When cloning, the objects in the list are NOT cloned, only the references.
*
* @author Thomas Morgner
*/
public class ObjectList extends AbstractObjectList {
/**
* Default constructor.
*/
public ObjectList() {
}
/**
* Creates a new list.
*
* @param initialCapacity the initial capacity.
*/
public ObjectList(final int initialCapacity) {
super(initialCapacity);
}
// NOTE: the methods below look redundant, but their purpose is to provide public
// access to the the get(), set() and indexOf() methods defined in the
// AbstractObjectList class, for this class only. For other classes
// (e.g. PaintList, ShapeList etc) we don't want the Object versions of these
// methods to be visible in the public API.
/**
* Returns the object at the specified index, if there is one, or null.
*
* @param index the object index.
*
* @return The object or null.
*/
public Object get(final int index) {
return super.get(index);
}
/**
* Sets an object reference (overwriting any existing object).
*
* @param index the object index.
* @param object the object (null permitted).
*/
public void set(final int index, final Object object) {
super.set(index, object);
}
/**
* Returns the index of the specified object, or -1 if the object is not in the list.
*
* @param object the object.
*
* @return The index or -1.
*/
public int indexOf(final Object object) {
return super.indexOf(object);
}
}