l2j-server-game/L2J_Server_BETA/java/com/l2jserver/util/L2FastList.java

/*
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program 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 General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package com.l2jserver.util;

import java.util.List;

import javolution.util.FastList;

/**
 * A custom version of LinkedList with extension for iterating without using temporary collection<br>
 * It`s provide synchronization lock when iterating if needed<br>
 * <br>
 * @author Julian Version 1.0.1 (2008-02-07)<br>
 *         Changes:<br>
 *         1.0.0 - Initial version.<br>
 *         1.0.1 - Made forEachP() final.<br>
 * @param <T>
 */
public class L2FastList<T extends Object> extends FastList<T>
{
	static final long serialVersionUID = 1L;
	
	/**
	 * Public inner interface used by ForEach iterations<br>
	 * @author Julian
	 * @param <T>
	 */
	public interface I2ForEach<T>
	{
		public boolean ForEach(T obj);
	}
	
	public L2FastList()
	{
		super();
	}
	
	public L2FastList(List<? extends T> list)
	{
		super(list);
	}
	
	/**
	 * Public method that iterate entire collection.<br>
	 * <br>
	 * @param func - a class method that must be executed on every element of collection.<br>
	 * @return - returns true if entire collection is iterated, false if it`s been interrupted by<br>
	 *         check method (I2ForEach.forEach())<br>
	 */
	public boolean forEach(I2ForEach<T> func)
	{
		for (T e : this)
		{
			if (!func.ForEach(e))
			{
				return false;
			}
		}
		return true;
	}
}