MyxNullProgressMonitor.java

/*******************************************************************************
 * Copyright (c) 2000, 2006 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.archstudio.myx.fw;

/**
 * A default progress monitor implementation suitable for subclassing.
 * <p>
 * This implementation supports cancelation. The default implementations of the other methods do nothing.
 * </p>
 * <p>
 * This class can be used without OSGi running.
 * </p>
 */
public class MyxNullProgressMonitor implements IMyxProgressMonitor {

	/**
	 * Indicates whether cancel has been requested.
	 */
	private volatile boolean cancelled = false;

	/**
	 * Constructs a new progress monitor.
	 */
	public MyxNullProgressMonitor() {
		super();
	}

	/**
	 * This implementation does nothing. Subclasses may override this method to do interesting processing when a task
	 * begins.
	 * 
	 * @see IMyxProgressMonitor#beginTask(String, int)
	 */
	@Override
	public void beginTask(String name, int totalWork) {
		// do nothing
	}

	/**
	 * This implementation does nothing. Subclasses may override this method to do interesting processing when a task is
	 * done.
	 * 
	 * @see IMyxProgressMonitor#done()
	 */
	@Override
	public void done() {
		// do nothing
	}

	/**
	 * This implementation does nothing. Subclasses may override this method.
	 * 
	 * @see IMyxProgressMonitor#internalWorked(double)
	 */
	@Override
	public void internalWorked(double work) {
		// do nothing
	}

	/**
	 * This implementation returns the value of the internal state variable set by <code>setCanceled</code>. Subclasses
	 * which override this method should override <code>setCanceled</code> as well.
	 * 
	 * @see IMyxProgressMonitor#isCanceled()
	 * @see IMyxProgressMonitor#setCanceled(boolean)
	 */
	@Override
	public boolean isCanceled() {
		return cancelled;
	}

	/**
	 * This implementation sets the value of an internal state variable. Subclasses which override this method should
	 * override <code>isCanceled</code> as well.
	 * 
	 * @see IMyxProgressMonitor#isCanceled()
	 * @see IMyxProgressMonitor#setCanceled(boolean)
	 */
	@Override
	public void setCanceled(boolean cancelled) {
		this.cancelled = cancelled;
	}

	/**
	 * This implementation does nothing. Subclasses may override this method to do something with the name of the task.
	 * 
	 * @see IMyxProgressMonitor#setTaskName(String)
	 */
	@Override
	public void setTaskName(String name) {
		// do nothing
	}

	/**
	 * This implementation does nothing. Subclasses may override this method to do interesting processing when a subtask
	 * begins.
	 * 
	 * @see IMyxProgressMonitor#subTask(String)
	 */
	@Override
	public void subTask(String name) {
		// do nothing
	}

	/**
	 * This implementation does nothing. Subclasses may override this method to do interesting processing when some work
	 * has been completed.
	 * 
	 * @see IMyxProgressMonitor#worked(int)
	 */
	@Override
	public void worked(int work) {
		// do nothing
	}
}