KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > internal > corext > refactoring > JavaRefactoringContribution


1 /*******************************************************************************
2  * Copyright (c) 2005, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.internal.corext.refactoring;
12
13 import java.util.Map JavaDoc;
14
15 import org.eclipse.core.runtime.Assert;
16 import org.eclipse.core.runtime.CoreException;
17
18 import org.eclipse.ltk.core.refactoring.Refactoring;
19 import org.eclipse.ltk.core.refactoring.RefactoringContribution;
20 import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
21
22 /**
23  * Partial implementation of a java refactoring contribution.
24  *
25  * @since 3.2
26  */
27 public abstract class JavaRefactoringContribution extends RefactoringContribution {
28
29     /**
30      * {@inheritDoc}
31      */
32     public final RefactoringDescriptor createDescriptor(final String JavaDoc id, final String JavaDoc project, final String JavaDoc description, final String JavaDoc comment, final Map JavaDoc arguments, final int flags) {
33         return new JavaRefactoringDescriptor(this, id, project, description, comment, arguments, flags);
34     }
35
36     /**
37      * Creates the a new refactoring instance.
38      *
39      * @param descriptor
40      * the refactoring descriptor
41      * @return the refactoring, or <code>null</code>
42      * @throws CoreException
43      * if an error occurs while creating the refactoring
44      */
45     public abstract Refactoring createRefactoring(RefactoringDescriptor descriptor) throws CoreException;
46
47     /**
48      * {@inheritDoc}
49      */
50     public final Map JavaDoc retrieveArgumentMap(final RefactoringDescriptor descriptor) {
51         Assert.isNotNull(descriptor);
52         if (descriptor instanceof JavaRefactoringDescriptor)
53             return ((JavaRefactoringDescriptor) descriptor).getArguments();
54         return super.retrieveArgumentMap(descriptor);
55     }
56 }
57
Popular Tags