ProjectXmlSavedHook


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.modules.ruby.spi.project.support.rake;
21  
22  import java.io.IOException  ;
23  
24  /**
25   * Hook run when <code>nbproject/project.xml</code> is saved.
26   * An instance should be placed into a project's lookup to register it.
27   * @see org.netbeans.api.project.Project#getLookup
28   * @author Jesse Glick
29   */
30  public abstract class ProjectXmlSavedHook {
31  
32      /**
33       * Default constructor for subclasses.
34       */
35      protected ProjectXmlSavedHook() {}
36  
37      /**
38       * Called when shared project metadata (<code>project.xml</code>) has been modified.
39       * <p>
40       * Also called the first the time a project created by {@link ProjectGenerator}
41       * is saved.
42       * This is called during a project save event and so runs with write access.
43       * </p>
44       * <p class="nonnormative">
45       * Typically the project's <code>build.xml</code> and/or <code>nbproject/build-impl.xml</code>
46       * may need to be (re-)generated; see {@link GeneratedFilesHelper} for details.
47       * </p>
48       * @throws IOException if running the hook failed for some reason
49       */
50      protected abstract void projectXmlSaved() throws IOException  ;
51      
52  }
53
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags