content: /*******************************************************************************
   * Copyright (c) 2006, 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
   *******************************************************************************/
  package org.eclipse.wst.jsdt.internal.corext.refactoring.code;
  
  import org.eclipse.core.runtime.Assert;
  import org.eclipse.ltk.core.refactoring.Refactoring;
  import org.eclipse.ltk.core.refactoring.RefactoringStatus;
  import org.eclipse.wst.jsdt.internal.corext.refactoring.RefactoringCoreMessages;
  import org.eclipse.wst.jsdt.internal.corext.refactoring.tagging.ICommentProvider;
  import org.eclipse.wst.jsdt.internal.corext.refactoring.tagging.IScriptableRefactoring;
  import org.eclipse.wst.jsdt.internal.corext.util.Messages;
  import org.eclipse.wst.jsdt.ui.JavaScriptElementLabels;
  
  /**
   * Partial implementation of a scriptable refactoring which provides a comment
   * for the history.
   * 
   * 
   */
  public abstract class ScriptableRefactoring extends Refactoring implements IScriptableRefactoring, ICommentProvider {
  
  	/**
  	 * Creates a fatal error status telling that the input element does not
  	 * exist.
  	 * 
  	 * @param element
  	 *            the input element, or <code>null</code>
  	 * @param name
  	 *            the name of the refactoring
  	 * @param id
  	 *            the id of the refactoring
  	 * @return the refactoring status
  	 */
  	public static RefactoringStatus createInputFatalStatus(final Object element, final String name, final String id) {
  		Assert.isNotNull(name);
  		Assert.isNotNull(id);
  		if (element != null)
  			return RefactoringStatus.createFatalErrorStatus(Messages.format(RefactoringCoreMessages.InitializableRefactoring_input_not_exists, new String[] { JavaScriptElementLabels.getTextLabel(element, JavaScriptElementLabels.ALL_FULLY_QUALIFIED), name, id}));
  		else
  			return RefactoringStatus.createFatalErrorStatus(Messages.format(RefactoringCoreMessages.InitializableRefactoring_inputs_do_not_exist, new String[] { name, id}));
  	}
  
  	/**
  	 * Creates a warning status telling that the input element does not exist.
  	 * 
  	 * @param element
  	 *            the input element, or <code>null</code>
  	 * @param name
  	 *            the name of the refactoring
  	 * @param id
  	 *            the id of the refactoring
  	 * @return the refactoring status
  	 */
  	public static RefactoringStatus createInputWarningStatus(final Object element, final String name, final String id) {
  		Assert.isNotNull(name);
  		Assert.isNotNull(id);
  		if (element != null)
  			return RefactoringStatus.createWarningStatus(Messages.format(RefactoringCoreMessages.InitializableRefactoring_input_not_exists, new String[] { JavaScriptElementLabels.getTextLabel(element, JavaScriptElementLabels.ALL_FULLY_QUALIFIED), name, id}));
  		else
  			return RefactoringStatus.createWarningStatus(Messages.format(RefactoringCoreMessages.InitializableRefactoring_inputs_do_not_exist, new String[] { name, id}));
  	}
  
  	/** The comment */
  	private String fComment;
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public boolean canEnableComment() {
  		return true;
  	}
  
  	/**
  	 * Creates a fatal error status telling that the input element does not
  	 * exist.
  	 * 
  	 * @param element
  	 *            the input element, or <code>null</code>
  	 * @param id
  	 *            the id of the refactoring
  	 * @return the refactoring status
  	 */
  	public final RefactoringStatus createInputFatalStatus(final Object element, final String id) {
  		return createInputFatalStatus(element, getName(), id);
  	}
  
  	/**
  	 * Creates a warning status telling that the input element does not exist.
  	 * 
  	 * @param element
  	 *            the input element, or <code>null</code>
  	 * @param id
  	 *            the id of the refactoring
  	 * @return the refactoring status
  	 */
  	public final RefactoringStatus createInputWarningStatus(final Object element, final String id) {
  		return createInputWarningStatus(element, getName(), id);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public String getComment() {
  		return fComment;
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public void setComment(String comment) {
  		fComment= comment;
  	}
  }
  