KickJava   Java API By Example, From Geeks To Geeks.

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


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.jdt.internal.corext.refactoring.tagging;
12
13 /**
14  * Interface for refactorings which are able to create
15  * appropriate delegates for the refactored elements.
16  *
17  * @since 3.2
18  *
19  */
20 public interface IDelegateUpdating {
21
22     /**
23      * Performs a dynamic check whether this refactoring object is capable of
24      * creating appropriate delegates for the refactored elements. The
25      * return value of this method may change according to the state of the
26      * refactoring.
27      */
28     public boolean canEnableDelegateUpdating();
29
30     /**
31      * If <code>canEnableDelegateUpdating</code> returns
32      * <code>true</code>, then this method is used to ask the refactoring
33      * object whether delegates will be created.
34      * This call can be ignored if <code>canEnableDelegateUpdating</code>
35      * returns <code>false</code>.
36      */
37     public boolean getDelegateUpdating();
38
39     /**
40      * Returns the title of the preference to update delegates in the user
41      * interface.
42      *
43      * @param plural
44      * <code>true</code> if several delegates are created,
45      * <code>false</code> otherwise
46      * @return the non-null string denoting the title
47      */
48     public String JavaDoc getDelegateUpdatingTitle(boolean plural);
49
50     /**
51      * If <code>canEnableDelegateUpdating</code> returns
52      * <code>true</code>, then this method is used to ask the refactoring
53      * object whether delegates will be deprecated.
54      * This call can be ignored if <code>canEnableDelegateUpdating</code>
55      * returns <code>false</code>.
56      */
57     public boolean getDeprecateDelegates();
58     
59     /**
60      * If <code>canEnableDelegateUpdating</code> returns
61      * <code>true</code>, then this method may be called to set whether
62      * to create delegates.
63      * This call can be ignored if <code>canEnableDelegateUpdating</code>
64      * returns <code>false</code>.
65      */
66     public void setDelegateUpdating(boolean updating);
67     
68     /**
69      * If <code>canEnableDelegateUpdating</code> returns
70      * <code>true</code>, then this method may be called to set whether
71      * to deprecate delegates.
72      * This call can be ignored if <code>canEnableDelegateUpdating</code>
73      * returns <code>false</code>.
74      */
75     public void setDeprecateDelegates(boolean deprecate);
76 }
77
Popular Tags