KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > internal > corext > refactoring > tagging > ITextUpdating


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.tagging;
12
13 public interface ITextUpdating {
14
15     /**
16      * Performs a dynamic check whether this refactoring object is capable of
17      * updating references to the renamed element.
18      */
19     public boolean canEnableTextUpdating();
20     
21     /**
22      * If <code>canEnableTextUpdating</code> returns <code>true</code>,
23      * then this method is used to ask the refactoring object whether references
24      * in regular (non JavaDoc) comments and string literals should be updated.
25      * This call can be ignored if <code>canEnableTextUpdating</code> returns
26      * <code>false</code>.
27      */
28     public boolean getUpdateTextualMatches();
29     
30     /**
31      * If <code>canEnableTextUpdating</code> returns <code>true</code>,
32      * then this method is used to inform the refactoring object whether references
33      * in regular (non JavaDoc) comments and string literals should be updated.
34      * This call can be ignored if <code>canEnableTextUpdating</code> returns
35      * <code>false</code>.
36      */
37     public void setUpdateTextualMatches(boolean update);
38     
39     /**
40      * Returns the current name of the element to be renamed.
41      *
42      * @return the current name of the element to be renamed
43      */
44     public String JavaDoc getCurrentElementName();
45     
46     /**
47      * Returns the current qualifier of the element to be renamed.
48      *
49      * @return the current qualifier of the element to be renamed
50      */
51     public String JavaDoc getCurrentElementQualifier();
52     
53     /**
54      * Returns the new name of the element
55      *
56      * @return the new element name
57      */
58     public String JavaDoc getNewElementName();
59 }
60
61
62
Popular Tags