ant/org.eclipse.ant.ui/Ant Tools Support/org/eclipse/ant/internal/ui/launchConfigurations/AntTargetContentProvider.java

/*******************************************************************************
 * Copyright (c) 2000, 2003 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ant.internal.ui.launchConfigurations;


import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

import org.eclipse.ant.core.TargetInfo;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;

public class AntTargetContentProvider implements IStructuredContentProvider {

	protected List elements = new ArrayList();
	protected TableViewer viewer;
	private boolean fFilterInternalTargets= false;
	private int fNumFilteredTargets= 0;
	private int fNumTotalTargets= 0;

	public void add(Object o) {
		elements.add(o);
		viewer.add(o);
	}
	
	public void addAll(List list) {
		elements.addAll(list);
		viewer.add(list.toArray());
	}

	public void dispose() {
	}

	public Object[] getElements(Object inputElement) {
		fNumTotalTargets= elements.size();
		fNumFilteredTargets= 0;
		if (fNumTotalTargets == 0) {
			return new Object[0];
		}
		if (!fFilterInternalTargets) {
			return elements.toArray(new Object[fNumTotalTargets]);
		}
		Iterator iter= elements.iterator();
		while (iter.hasNext()) { 
			if (isInternal((TargetInfo) iter.next())) {
				fNumFilteredTargets++;
			}
		}
		Object[] targets= new Object[getNumTargets()];
		iter= elements.iterator();
		int i= 0;
		while (iter.hasNext()) {
			TargetInfo target= (TargetInfo) iter.next(); 
			if (!isInternal(target)) {
				targets[i++]= target;  
			}
		}
		return targets;
	}
	
	/**
	 * Returns whether the given target is an internal target. Internal
	 * targets are targets which has no description. The default target
	 * is never considered internal.
	 * @param target the target to examine
	 * @return whether the given target is an internal target
	 */
	public boolean isInternal(TargetInfo target) {
		return !target.isDefault() && target.getDescription() == null;
	}

	public void inputChanged(Viewer newViewer, Object oldInput, Object newInput) {
		this.viewer = (TableViewer) newViewer;
		elements.clear();
		if (newInput != null && ((Object[]) newInput).length != 0) {
			elements.addAll(Arrays.asList((Object[]) newInput));
		}
	}
	
	/**
	 * Removes the given target from the list of targets. Has no effect if the
	 * given target does not exist in the list.
	 * 
	 * @param target the target to remove
	 */
	public void removeTarget(Object target) {
		elements.remove(target);
		viewer.remove(target);
	}

	/**
	 * Moves the given target up in the list of active targets. Has no effect if
	 * the given target is already the first target in the list or the given
	 * index is invalid.
	 * 
	 * @param index the index of the target to move up
	 */
	public void moveUpTarget(int index) {
		Object target = elements.get(index);
		if (index == 0 || target == null) {
			return;
		}
		elements.set(index, elements.get(index - 1));
		elements.set(index - 1, target);
	}

	/**
	 * Moves the given target down in the list of active targets. Has no effect
	 * if the given target is already the last target in the list or the given
	 * index is invalid.
	 *
	 * @param index the index of the target to move down
	 */
	public void moveDownTarget(int index) {
		Object target = elements.get(index);
		if (index == elements.size() - 1 || target == null) {
			return;
		}
		elements.set(index, elements.get(index + 1));
		elements.set(index + 1, target);
	}
	
	/**
	 * Returns the number of targets filtered out of the list
	 * of targets last returned by this content provider
	 * @return the number of targets filtered out of the last request
	 *  for targets
	 */
	public int getNumFiltered() {
		return fNumFilteredTargets;
	}
	
	/**
	 * Returns the number of targets returned the last time this content
	 * provider was queried. If targets were filtered out, those targets are
	 * not included in this count.
	 * @return the number of targets returned the last time targets
	 *  were requested
	 */
	public int getNumTargets() {
		return fNumTotalTargets - fNumFilteredTargets;
	}
	
	/**
	 * Sets whether this content provider should filter out internal targets.
	 * Internal targets are targets which have no description. If set <code>true</code>,
	 * targets with no description will not be returned when getElements() is called.
	 * @param filter sets whether internal targets should be filtered out
	 */
	public void setFilterInternalTargets(boolean filter) {
		fFilterInternalTargets= filter;
	}
}