KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ltk > core > refactoring > participants > RefactoringArguments


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.participants;
12
13 /**
14  * A generic super class of all refactoring specific argument
15  * classes.
16  * <p>
17  * The main purpose of this class is to not use <code>Object</code>
18  * in signatures. This helps to distinguish between the element to
19  * be refactored and the arguments needed to carry out the refactoring.
20  * </p>
21  * <p>
22  * This class should be subclassed by clients wishing to provide special
23  * refactoring arguments for special participants.
24  * </p>
25  *
26  * @since 3.0
27  */
28 public abstract class RefactoringArguments {
29
30     /**
31      * Creates new refactoring arguments.
32      */
33     protected RefactoringArguments() {
34     }
35     
36     /**
37      * Returns a string representation of these arguments suitable for debugging
38      * purposes only.
39      * <p>
40      * Subclasses should reimplement this method.
41      * </p>
42      *
43      * @return a debug string
44      * @since 3.2
45      */
46     public String JavaDoc toString() {
47         return super.toString();
48     }
49 }
50
Popular Tags