GuardedBlockHandler


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 java.util.Collection  ;
22  import org.netbeans.modules.refactoring.api.Problem;
23  import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;
24  
25  /** Interface implemented by guarded block refactoring handlers. Contains a callback method
26   * that gets a RefactoringElementImplementation affecting a guarded block as a parameter and can return
27   * the new RefactoringElementImplementation that will replace the passed RefactoringElementImplementations
28   * in the result collection of refactoring elements for a given refactoring.
29   *
30   * @author Martin Matula
31   */
32  public interface GuardedBlockHandler {
33      /** Collects replacements for refactoring element affecting a guarded block.
34       * @param proposedChange RefactoringElementImplementation that affects a guarded block.
35       * @param replacements Empty collection where the method implementation should add the
36       * replacement RefactoringElementImplementations if this GuardedBlockHandler can handle changes in the
37       * guarded block the original RefactoringElementImplementation affects.
38       * @param transaction collection of Transactions. 
39       *
40       * @return Problems found or null (if no problems were identified)
41       */
42      Problem handleChange(RefactoringElementImplementation proposedChange, Collection  <RefactoringElementImplementation> replacements, Collection  <Transaction> transaction);
43  }
44
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags