svndigest - svndigest

src/core/net/sf/basedb/util/collections/RemoveAllTransformer.java

: Code
: Comments
: Other

Rev	Date	Author	Line
4712	19 Dec 08	nicklas	1	/**
4712	19 Dec 08	nicklas	2	$Id$
4712	19 Dec 08	nicklas	3
4712	19 Dec 08	nicklas	4	Copyright (C) 2008 Nicklas Nordborg
4712	19 Dec 08	nicklas	5
4712	19 Dec 08	nicklas	6	This file is part of BASE - BioArray Software Environment.
4712	19 Dec 08	nicklas	7	Available at http://base.thep.lu.se/
4712	19 Dec 08	nicklas	8
4712	19 Dec 08	nicklas	9	BASE is free software; you can redistribute it and/or
4712	19 Dec 08	nicklas	10	modify it under the terms of the GNU General Public License
4712	19 Dec 08	nicklas	11	as published by the Free Software Foundation; either version 3
4712	19 Dec 08	nicklas	12	of the License, or (at your option) any later version.
4712	19 Dec 08	nicklas	13
4712	19 Dec 08	nicklas	14	BASE is distributed in the hope that it will be useful,
4712	19 Dec 08	nicklas	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
4712	19 Dec 08	nicklas	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4712	19 Dec 08	nicklas	17	GNU General Public License for more details.
4712	19 Dec 08	nicklas	18
4712	19 Dec 08	nicklas	19	You should have received a copy of the GNU General Public License
4712	19 Dec 08	nicklas	20	along with BASE. If not, see <http://www.gnu.org/licenses/>.
4712	19 Dec 08	nicklas	21	*/
4712	19 Dec 08	nicklas	22	package net.sf.basedb.util.collections;
4712	19 Dec 08	nicklas	23
4712	19 Dec 08	nicklas	24	import java.util.Collection;
4712	19 Dec 08	nicklas	25
4712	19 Dec 08	nicklas	26	/**
4712	19 Dec 08	nicklas	27	Collection transformer implementation that removes all elements in
4712	19 Dec 08	nicklas	28	the source collection from the destination collection. This
4712	19 Dec 08	nicklas	29	is equivalent to <code>destination.removeAll(source)</code>.
4712	19 Dec 08	nicklas	30
4712	19 Dec 08	nicklas	31	@author Nicklas
4712	19 Dec 08	nicklas	32	@version 2.10
4712	19 Dec 08	nicklas	33	@base.modified $Date$
4712	19 Dec 08	nicklas	34	*/
4712	19 Dec 08	nicklas	35	public class RemoveAllTransformer<I>
4712	19 Dec 08	nicklas	36	implements CollectionTransformer<I, I>
4712	19 Dec 08	nicklas	37	{
4712	19 Dec 08	nicklas	38
4712	19 Dec 08	nicklas	39	public RemoveAllTransformer()
4712	19 Dec 08	nicklas	40	{}
4712	19 Dec 08	nicklas	41	/*
4712	19 Dec 08	nicklas	42	From the CollectionTransformer interface
4712	19 Dec 08	nicklas	43	----------------------------------------
4712	19 Dec 08	nicklas	44	*/
4712	19 Dec 08	nicklas	45	/**
4712	19 Dec 08	nicklas	46	Remove all elements in the source collection from the destination collection.
4712	19 Dec 08	nicklas	47	@return The number of elements removed
4712	19 Dec 08	nicklas	48	*/
4712	19 Dec 08	nicklas	49	@Override
4712	19 Dec 08	nicklas	50	public int transform(Collection<? extends I> source, Collection<? super I> destination)
4712	19 Dec 08	nicklas	51	{
4712	19 Dec 08	nicklas	52	int size = destination.size();
4712	19 Dec 08	nicklas	53	destination.removeAll(source);
4712	19 Dec 08	nicklas	54	return size - destination.size();
4712	19 Dec 08	nicklas	55	}
4712	19 Dec 08	nicklas	56	// ------------------------------------------
4712	19 Dec 08	nicklas	57
4712	19 Dec 08	nicklas	58	}