KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ltk > core > refactoring > RefactoringChangeDescriptor


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.ltk.core.refactoring;
12
13 /**
14  * A {@link RefactoringChangeDescriptor} describes changes created by a
15  * refactoring. Changes created by a refactoring should provide an appropriate
16  * refactoring change descriptor, which allows to completely reconstruct the
17  * particular refactoring instance from the encapsulated refactoring descriptor.
18  * <p>
19  * Note: this class is not intended to be subclassed by clients.
20  * </p>
21  *
22  * @since 3.2
23  */
24 public class RefactoringChangeDescriptor extends ChangeDescriptor {
25
26     /** The refactoring descriptor */
27     private final RefactoringDescriptor fRefactoringDescriptor;
28
29     /**
30      * Creates the <code>RefactoringChangeDescriptor</code> with the
31      * {@link RefactoringDescriptor} that originated the change.
32      *
33      * @param descriptor
34      * the {@link RefactoringDescriptor} that originated the change.
35      */
36     public RefactoringChangeDescriptor(final RefactoringDescriptor descriptor) {
37         fRefactoringDescriptor= descriptor;
38     }
39
40     /**
41      * Returns the {@link RefactoringDescriptor} that originated the change.
42      *
43      * @return the {@link RefactoringDescriptor} that originated the change.
44      */
45     public RefactoringDescriptor getRefactoringDescriptor() {
46         return fRefactoringDescriptor;
47     }
48 }
49
Popular Tags