CapturedRefactoringDescriptor.java

/**
 * This file is licensed under the University of Illinois/NCSA Open Source License. See LICENSE.TXT for details.
 */
package edu.illinois.codingspectator.refactorings.parser;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

import org.eclipse.jdt.core.refactoring.descriptors.JavaRefactoringDescriptor;
import org.eclipse.jdt.core.refactoring.descriptors.MoveDescriptor;
import org.eclipse.jdt.internal.corext.refactoring.code.ExtractConstantRefactoring;
import org.eclipse.jdt.internal.corext.refactoring.code.ExtractMethodRefactoring;
import org.eclipse.jdt.internal.corext.refactoring.code.InlineConstantRefactoring;
import org.eclipse.jdt.internal.corext.refactoring.structure.ExtractInterfaceProcessor;
import org.eclipse.jdt.internal.corext.refactoring.structure.ExtractSupertypeProcessor;
import org.eclipse.jdt.internal.corext.refactoring.structure.PullUpRefactoringProcessor;
import org.eclipse.jdt.internal.corext.refactoring.structure.constraints.SuperTypeRefactoringProcessor;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
import org.eclipse.ltk.core.refactoring.codingspectator.Logger;
import org.eclipse.ltk.internal.core.refactoring.history.DefaultRefactoringDescriptor;

/**
 * 
 * This class provides provides easy access to the contents of a refactoring descriptor.
 * 
 * @author Mohsen Vakilian
 * @author nchen
 * 
 */
@SuppressWarnings("restriction")
public class CapturedRefactoringDescriptor {

	private DefaultRefactoringDescriptor descriptor;

	public CapturedRefactoringDescriptor(DefaultRefactoringDescriptor descriptor) {
		this.descriptor= descriptor;
	}

	@SuppressWarnings("rawtypes")
	public Map getArguments() {
		return descriptor.getArguments();
	}

	@SuppressWarnings({ "unchecked" })
	public Set<String> getAttributeKeys() {
		return Collections.unmodifiableSet(getArguments().keySet());
	}

	public String getAttribute(String attributeKey) {
		return (String)getArguments().get(attributeKey);
	}

	public String getComment() {
		return descriptor.getComment();
	}

	public String getDescription() {
		return descriptor.getDescription();
	}

	public int getFlags() {
		return descriptor.getFlags();
	}

	public String getID() {
		return descriptor.getID();
	}

	public String getProject() {
		return descriptor.getProject();
	}

	public long getTimestamp() {
		return descriptor.getTimeStamp();
	}

	/*
	 * FIXME: There are a lot of attributes. I think it's better to remove the following getter methods and the changes we've made to the visibility of the corresponding constants.
	 */

	public String getElement() {
		return getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_ELEMENT);
	}

	public String getInput() {
		return getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_INPUT);
	}

	public String getName() {
		return getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_NAME);
	}

	public boolean doesReference() {
		return Boolean.valueOf(getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_REFERENCES));
	}

	public String getSelection() {
		return getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_SELECTION);
	}

	// Attributes added by CodingSpectator

	public String getSelectionText() {
		return getAttribute(RefactoringDescriptor.ATTRIBUTE_SELECTION_TEXT);
	}

	public String getSelectionInCodeSnippet() {
		return getAttribute(RefactoringDescriptor.ATTRIBUTE_SELECTION_IN_CODE_SNIPPET);
	}

	public String getStatus() {
		return getAttribute(RefactoringDescriptor.ATTRIBUTE_STATUS);
	}

	public String getCodeSnippet() {
		return getAttribute(RefactoringDescriptor.ATTRIBUTE_CODE_SNIPPET);
	}

	public boolean isInvokedByQuickAssist() {
		return Boolean.valueOf(getAttribute(RefactoringDescriptor.ATTRIBUTE_INVOKED_BY_QUICKASSIST));
	}

	public String getNavigationHistory() {
		return getAttribute(Logger.NAVIGATION_HISTORY_ATTRIBUTE);
	}

	// Declared in ExtractMethodRefactoring and ExtractConstantRefactoring.
	public int getVisibility() {
		if (!"visibility".equals(ExtractMethodRefactoring.ATTRIBUTE_VISIBILITY) || !"visibility".equals(ExtractConstantRefactoring.ATTRIBUTE_VISIBILITY)) {
			throw new RuntimeException("Inconsistent attribute names.");
		}

		return Integer.valueOf(getAttribute(ExtractMethodRefactoring.ATTRIBUTE_VISIBILITY));
	}

	// Declared in ExtractMethodRefactoring.
	public int getDestination() {
		return Integer.valueOf(getAttribute(ExtractMethodRefactoring.ATTRIBUTE_DESTINATION));
	}

	// Declared in ExtractMethodRefactoring and ExtractInterfaceProcessor.
	public boolean getComments() {
		if (!"comments".equals(ExtractMethodRefactoring.ATTRIBUTE_COMMENTS) || !"comments".equals(ExtractInterfaceProcessor.ATTRIBUTE_COMMENTS)) {
			throw new RuntimeException("Inconsistent attribute names.");
		}

		return Boolean.valueOf(getAttribute("comments"));
	}

	// Declared in ExtractMethodRefactoring, InlineConstantRefactoring, ExtractConstantRefactoring and SuperTypeRefactoringProcessor.
	public boolean getReplace() {
		if (!"replace".equals(InlineConstantRefactoring.ATTRIBUTE_REPLACE) || !"replace".equals(ExtractMethodRefactoring.ATTRIBUTE_REPLACE)
				|| !"replace".equals(ExtractConstantRefactoring.ATTRIBUTE_REPLACE) || !"replace".equals(SuperTypeRefactoringProcessor.ATTRIBUTE_REPLACE)) {
			throw new RuntimeException("Inconsistent attribute names.");
		}

		return Boolean.valueOf(getAttribute("replace"));
	}

	// Declared in ExtractMethodRefactoring.
	public boolean getExceptions() {
		return Boolean.valueOf(getAttribute(ExtractMethodRefactoring.ATTRIBUTE_EXCEPTIONS));
	}

	// Declared in InlineConstantRefactoring.
	public boolean getRemove() {
		return Boolean.valueOf(getAttribute("remove"));
	}

	// Declared in ExtractConstantRefactoring.
	public boolean getQualify() {
		return Boolean.valueOf(getAttribute(ExtractConstantRefactoring.ATTRIBUTE_QUALIFY));
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public String getElement(int index) {
		return getAttribute(JavaRefactoringDescriptor.ATTRIBUTE_ELEMENT + index);
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public boolean getQualified() {
		return Boolean.valueOf(getAttribute(MoveDescriptor.ATTRIBUTE_QUALIFIED));
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public String getTarget() {
		return getAttribute(MoveDescriptor.ATTRIBUTE_TARGET);
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public int getFiles() {
		return Integer.parseInt(getAttribute(MoveDescriptor.ATTRIBUTE_FILES));
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public int getFolders() {
		return Integer.parseInt(getAttribute(MoveDescriptor.ATTRIBUTE_FOLDERS));
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public String getPolicy() {
		return getAttribute(MoveDescriptor.ATTRIBUTE_POLICY);
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public int getUnits() {
		return Integer.parseInt(getAttribute(MoveDescriptor.ATTRIBUTE_UNITS));
	}

	// Used in MoveFilesFoldersAndCusPolicy.
	public String getPatterns() {
		return getAttribute(MoveDescriptor.ATTRIBUTE_PATTERNS);
	}

	// Used in ExtractInterfaceProcessor.
	public boolean getAbstract() {
		return Boolean.valueOf(getAttribute(ExtractInterfaceProcessor.ATTRIBUTE_ABSTRACT));
	}

	// Used in ExtractInterfaceProcessor.
	public boolean getPublic() {
		return Boolean.valueOf(getAttribute(ExtractInterfaceProcessor.ATTRIBUTE_PUBLIC));
	}

	// Used in SuperTypeRefactoringProcessor.
	public boolean getInstanceOf() {
		return Boolean.valueOf(getAttribute(SuperTypeRefactoringProcessor.ATTRIBUTE_INSTANCEOF));
	}

	// Used in PullUpRefactoringProcessor.
	public boolean getStubs() {
		return Boolean.valueOf(getAttribute(PullUpRefactoringProcessor.ATTRIBUTE_STUBS));
	}

	// Used in ExtractSupertypeProcessor.
	public int getExtract() {
		return Integer.parseInt(getAttribute(ExtractSupertypeProcessor.ATTRIBUTE_EXTRACT));
	}

	// Used in PullUpRefactoringProcessor.
	public int getDelete() {
		return Integer.parseInt(getAttribute(PullUpRefactoringProcessor.ATTRIBUTE_DELETE));
	}

	// Used in PullUpRefactoringProcessor.
	public int getIntegerAbstract() {
		return Integer.parseInt(getAttribute(PullUpRefactoringProcessor.ATTRIBUTE_ABSTRACT));
	}

	// Used in ExtractSupertypeProcessor.
	public int getTypes() {
		return Integer.parseInt(getAttribute(ExtractSupertypeProcessor.ATTRIBUTE_TYPES));
	}

	// Used in ExtractMethodRefactoring.
	public String getParameter(int index) {
		return getAttribute(ExtractMethodRefactoring.ATTRIBUTE_PARAMETER + index);
	}

}