AntArtifactQueryImplementation


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.spi.project.ant;
21  
22  import java.io.File  ;
23  import org.netbeans.api.project.ant.AntArtifact;
24  
25  /**
26   * Represents knowledge about the origin of an Ant build product.
27   * <p>
28   * Normal code does not need to implement this query. A standard implementation
29   * first finds an associated {@link org.netbeans.api.project.Project} and
30   * then checks to see if it supports {@link org.netbeans.spi.project.ant.AntArtifactProvider}.
31   * You would only need to implement this directly in case your project type
32   * generated build artifacts outside of the project directory or otherwise not marked
33   * as "owned" by you according to {@link org.netbeans.api.project.FileOwnerQuery}.
34   * @see org.netbeans.api.project.ant.AntArtifactQuery
35   * @author Jesse Glick
36   */
37  public interface AntArtifactQueryImplementation {
38  
39      /**
40       * Find an Ant build artifact corresponding to a given file.
41       * @param file a file on disk (need not currently exist) which might be a build artifact from an Ant script
42       * @return an artifact information object, or null if it is not recognized
43       */
44      AntArtifact findArtifact(File   file);
45      
46  }
47
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags