l2j-server-game/L2_GameServer/java/net/sf/l2j/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 net.sf.l2j.util;

import java.util.LinkedList;

/**
*
* 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>
*/
public class L2FastList<T extends Object> extends LinkedList<T>
{
	static final long serialVersionUID = 1L;
	
    /**
     * Public inner interface used by ForEach iterations<br>
     *
     * @author  Julian
     */
	public interface I2ForEach<T> {
		public boolean ForEach(T obj);
	}
	
     /**
      * Public method that iterate entire collection.<br>
      * <br>
      * @param func - a class method that must be executed on every element of collection.<br>
      * @param sync - if set to true, will lock entire collection.<br>
      * @return - returns true if entire collection is iterated, false if it`s been interrupted by<br>
      *             check method (I2ForEach.forEach())<br>
      */
	public final boolean forEach(I2ForEach<T> func, boolean sync) {
		if (sync)
			synchronized(this) { return forEachP(func); }
		else
			return forEachP(func);
	}
	
    // private method that implements forEach iteration
	private final boolean forEachP(I2ForEach<T> func) {
		for (T e: this)
			if (!func.ForEach(e)) return false;
		return true;
	}
}