Mercurial > projects > dwt2
view org.eclipse.core.commands/src/org/eclipse/core/commands/operations/AbstractOperation.d @ 12:bc29606a740c
Added dwt-addons in original directory structure of eclipse.org
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 14 Mar 2009 18:23:29 +0100 |
parents | |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2005, 2008 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 * Port to the D programming language: * Frank Benoit <benoit@tionex.de> *******************************************************************************/ module org.eclipse.core.commands.operations.AbstractOperation; import org.eclipse.core.commands.ExecutionException; import org.eclipse.core.runtime.Assert; import org.eclipse.core.runtime.IAdaptable; import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.commands.operations.IUndoableOperation; import org.eclipse.core.commands.operations.IUndoContext; import java.lang.all; import java.util.List; import java.util.ArrayList; /** * <p> * Abstract implementation for an undoable operation. At a minimum, subclasses * should implement behavior for * {@link IUndoableOperation#execute(org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IAdaptable)}, * {@link IUndoableOperation#redo(org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IAdaptable)}, * and * {@link IUndoableOperation#undo(org.eclipse.core.runtime.IProgressMonitor, org.eclipse.core.runtime.IAdaptable)}. * </p> * * @see org.eclipse.core.commands.operations.IUndoableOperation * * @since 3.1 */ public abstract class AbstractOperation : IUndoableOperation { List contexts; private String label = ""; //$NON-NLS-1$ /** * Construct an operation that has the specified label. * * @param label * the label to be used for the operation. Should never be * <code>null</code>. */ public this(String label) { Assert.isNotNull(label); this.label = label; contexts = new ArrayList(); } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#addContext(org.eclipse.core.commands.operations.IUndoContext) * * <p> Subclasses may override this method. </p> */ public void addContext(IUndoContext context) { if (!contexts.contains(cast(Object)context)) { contexts.add(cast(Object)context); } } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#canExecute() * <p> Default implementation. Subclasses may override this method. * </p> * */ public bool canExecute() { return true; } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#canRedo() * <p> Default implementation. Subclasses may override this method. * </p> */ public bool canRedo() { return true; } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#canUndo() * <p> Default implementation. Subclasses may override this method. * </p> */ public bool canUndo() { return true; } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#dispose() * <p> Default implementation. Subclasses may override this method. * </p> */ public void dispose() { // nothing to dispose. } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#execute(org.eclipse.core.runtime.IProgressMonitor, * org.eclipse.core.runtime.IAdaptable) */ public abstract IStatus execute(IProgressMonitor monitor, IAdaptable info); public final IUndoContext[] getContexts() { return arraycast!(IUndoContext)(contexts.toArray()); } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#getLabel() * <p> Default implementation. Subclasses may override this method. * </p> */ public String getLabel() { return label; } /** * Set the label of the operation to the specified name. * * @param name * the string to be used for the label. Should never be * <code>null</code>. */ public void setLabel(String name) { label = name; } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#hasContext(org.eclipse.core.commands.operations.IUndoContext) */ public final bool hasContext(IUndoContext context) { Assert.isNotNull(cast(Object)context); for (int i = 0; i < contexts.size(); i++) { IUndoContext otherContext = cast(IUndoContext)contexts.get(i); // have to check both ways because one context may be more general // in // its matching rules than another. if (context.matches(otherContext) || otherContext.matches(context)) { return true; } } return false; } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#redo(org.eclipse.core.runtime.IProgressMonitor, * org.eclipse.core.runtime.IAdaptable) */ public abstract IStatus redo(IProgressMonitor monitor, IAdaptable info); /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#removeContext(org.eclipse.core.commands.operations.IUndoContext) * <p> Default implementation. Subclasses may override this method. * </p> */ public void removeContext(IUndoContext context) { contexts.remove(cast(Object)context); } /* * (non-Javadoc) * * @see org.eclipse.core.commands.operations.IUndoableOperation#undo(org.eclipse.core.runtime.IProgressMonitor, * org.eclipse.core.runtime.IAdaptable) */ public abstract IStatus undo(IProgressMonitor monitor, IAdaptable info); /** * The string representation of this operation. Used for debugging purposes * only. This string should not be shown to an end user. * * @return The string representation. */ public override String toString() { StringBuffer stringBuffer = new StringBuffer(); stringBuffer.append(getLabel()); stringBuffer.append("("); //$NON-NLS-1$ IUndoContext[] contexts = getContexts(); for (int i = 0; i < contexts.length; i++) { stringBuffer.append((cast(Object)contexts[i]).toString()); if (i !is contexts.length - 1) { stringBuffer.append(','); } } stringBuffer.append(')'); return stringBuffer.toString(); } }