XMLCatalogProvider


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.xml.retriever;
21  
22  import java.net.URI  ;
23  import org.openide.filesystems.FileObject;
24  
25  /**
26   * The XMLCatalogProvider allows a {@link org.netbeans.api.project.Project} to
27   * convey information about the XML catalog file usage within the project.
28   * @see org.netbeans.api.project.Project#getLookup
29   * @author Chris Webster
30   * @author Girish
31   */
32  public interface XMLCatalogProvider {
33      /**
34       * This constant identifies source roots which can be used to store
35       * retrieved XML artifacts.
36       */
37      public static final String   TYPE_RETRIEVED = "retrieved"; //NOI18N
38      
39      /**
40       * Provide the project root relative reference to the catalog file
41       * for the specified XML artifact.
42       * @param targetFile represents the XML artifact which may require use of
43       * a catalog for resolution. The common case, a single project wide catalog
44       * file, would delegate to #getProjectWideCatalog().
45       * @return a URI representing the relative path from the project root to the
46       * catalog file (i.e. ./catalog.xml which is the default)
47       */
48      URI   getCatalog(FileObject targetFile);
49      
50      /**
51       * Provide the project root relative reference to the catalog file
52       * @return a URI representing the relative path from the project root to the
53       * catalog file (i.e. ./catalog.xml which is the default)
54       */
55      URI   getProjectWideCatalog();
56      
57  }
58
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags