KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
14  * Interface implemented by processors able to rename similar declarations.
15  *
16  * @since 3.2
17  */

18 public interface ISimilarDeclarationUpdating {
19
20     /**
21      * Checks if this refactoring object is capable of updating similar declarations
22      * of the renamed element.
23      *
24      * This can be disabled globally by setting the product configuration property
25      * "org.eclipse.jdt.ui.refactoring.handlesSimilarDeclarations" to "false".
26      */

27     public boolean canEnableSimilarDeclarationUpdating();
28
29     /**
30      * If <code>canEnableSimilarElementUpdating</code> returns
31      * <code>true</code>, then this method is used to inform the refactoring
32      * object whether similar declarations should be updated. This call can be
33      * ignored if <code>canEnableSimilarElementUpdating</code> returns
34      * <code>false</code>.
35      */

36     public void setUpdateSimilarDeclarations(boolean update);
37
38     /**
39      * If <code>canEnableSimilarElementUpdating</code> returns
40      * <code>true</code>, then this method is used to ask the refactoring
41      * object whether similar declarations should be updated. This call can be
42      * ignored if <code>canEnableSimilarElementUpdating</code> returns
43      * <code>false</code>.
44      */

45     public boolean getUpdateSimilarDeclarations();
46
47     /**
48      * If <code>canEnableSimilarElementUpdating</code> returns
49      * <code>true</code>, then this method is used to set the match strategy
50      * for determining similarly named elements.
51      *
52      * @param selectedStrategy one of the STRATEGY_* constants in {@link org.eclipse.jdt.internal.corext.refactoring.rename.RenamingNameSuggestor}
53      */

54     public void setMatchStrategy(int selectedStrategy);
55
56     /**
57      * If <code>canEnableSimilarElementUpdating</code> returns
58      * <code>true</code>, then this method is used to ask the refactoring
59      * object which match strategy is used for determining similar elements.
60      *
61      * @return one of the STRATEGY_* constants in {@link org.eclipse.jdt.internal.corext.refactoring.rename.RenamingNameSuggestor}
62      */

63     public int getMatchStrategy();
64
65 }
Popular Tags