KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > gsf > InstantRenamer


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.gsf;
21
22 import java.util.List JavaDoc;
23 import java.util.Set JavaDoc;
24
25 import org.netbeans.api.gsf.OffsetRange;
26 import org.netbeans.api.gsf.CompilationInfo;
27
28 import org.netbeans.api.gsf.annotations.CheckForNull;
29 import org.netbeans.api.gsf.annotations.NonNull;
30 import org.netbeans.api.gsf.annotations.Nullable;
31
32
33 /**
34  * Provide an implementation that will help with instant renaming (in place refactoring)
35  *
36  * @author <a HREF="mailto:tor.norbye@sun.com">Tor Norbye</a>
37  */
38 public interface InstantRenamer {
39     /**
40      * Return true iff instant renaming is allowed for the given caret position
41      */
42     boolean isRenameAllowed(@NonNull CompilationInfo info, int caretOffset);
43
44     /**
45      * Return a Set of regions that should be renamed if the element under the caret offset is
46      * renamed.
47      */
48     @CheckForNull
49     Set JavaDoc<OffsetRange> getRenameRegions(@NonNull CompilationInfo info, int caretOffset);
50 }
51
Popular Tags