01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jdt.internal.corext.refactoring.tagging;
11:
12: public interface ITextUpdating {
13:
14: /**
15: * Performs a dynamic check whether this refactoring object is capable of
16: * updating references to the renamed element.
17: */
18: public boolean canEnableTextUpdating();
19:
20: /**
21: * If <code>canEnableTextUpdating</code> returns <code>true</code>,
22: * then this method is used to ask the refactoring object whether references
23: * in regular (non JavaDoc) comments and string literals should be updated.
24: * This call can be ignored if <code>canEnableTextUpdating</code> returns
25: * <code>false</code>.
26: */
27: public boolean getUpdateTextualMatches();
28:
29: /**
30: * If <code>canEnableTextUpdating</code> returns <code>true</code>,
31: * then this method is used to inform the refactoring object whether references
32: * in regular (non JavaDoc) comments and string literals should be updated.
33: * This call can be ignored if <code>canEnableTextUpdating</code> returns
34: * <code>false</code>.
35: */
36: public void setUpdateTextualMatches(boolean update);
37:
38: /**
39: * Returns the current name of the element to be renamed.
40: *
41: * @return the current name of the element to be renamed
42: */
43: public String getCurrentElementName();
44:
45: /**
46: * Returns the current qualifier of the element to be renamed.
47: *
48: * @return the current qualifier of the element to be renamed
49: */
50: public String getCurrentElementQualifier();
51:
52: /**
53: * Returns the new name of the element
54: *
55: * @return the new element name
56: */
57: public String getNewElementName();
58: }
|