KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > refactoring > spi > GuardedBlockHandlerFactory


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 package org.netbeans.modules.refactoring.spi;
20
21 import org.netbeans.modules.refactoring.api.AbstractRefactoring;
22
23 /** Factory for an object handling refactoring in a guarded block. This should be
24  * implemented by modules providing guarded sections in Java documents. If
25  * a change proposed by a refactoring affects a guarded section, the refactoring object
26  * asks the registered GuardedBlockHandlers to handle that change.
27  *
28  * @author Martin Matula
29  */
30 public interface GuardedBlockHandlerFactory {
31     /** Creates and returns a new instance of the guarded block refactoring handler or
32      * null if the handler is not suitable for the passed refactoring.
33      * @param refactoring Refactoring, the handler should be plugged in.
34      * @return Instance of GuardedBlockHandler or null if the handler is not applicable to
35      * the passed refactoring.
36      */
37     GuardedBlockHandler createInstance(AbstractRefactoring refactoring);
38 }
39
Popular Tags