RefreshConnectionsRequest.java

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

package org.eclipse.gmf.runtime.diagram.ui.requests;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.gef.Request;

/**
 * A request to refresh the connections. This request could have different
 * options indicating which or how the connections should be refreshed. Or we
 * could have different types depending on what type of relationships to
 * refresh.
 * 
 * @author cmahoney
 */
public class RefreshConnectionsRequest
	extends Request {

	/** A list of the view objects in <code>IAdaptable</code> form. */
	List shapes;

	/**
	 * true to turn on filtering, false to turn off filtering. By default,
	 * filtering is turned on
	 */
	boolean filter = true;

	/**
	 * Constructor.
	 * 
	 * @param shapes
	 *            list of the view objects in <code>IAdaptable</code> form
	 */
	public RefreshConnectionsRequest(List shapes) {
		super(RequestConstants.REQ_REFRESH_CONNECTIONS);

		this.shapes = new ArrayList(shapes);
	}

	/**
	 * Constructor. You can explicitly set the filtering with this constructor.
	 * 
	 * @param shapes
	 *            list of the view objects in <code>IAdaptable</code> form
	 * @param filter
	 *            true to turn on filtering, false to turn it off
	 */
	public RefreshConnectionsRequest(List shapes, boolean filter) {
		this(shapes);
		this.filter = filter;
	}

	/**
	 * Method getShapes.
	 * 
	 * @return List the list of <code>IAdaptable</code> shapes
	 */
	public List getShapes() {
		return shapes;
	}

	/**
	 * Returns if filtering is turned on or off.
	 * 
	 * @return true if filtering is turned on, false if it is turned off
	 */
	public boolean isFilter() {
		return filter;
	}

}