KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > retriever > catalog > CatalogWriteModelFactory


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.xml.retriever.catalog;
20
21 import org.netbeans.modules.xml.retriever.catalog.impl.CatalogModelFactoryImpl;
22 import org.netbeans.modules.xml.xam.locator.CatalogModelException;
23 import org.netbeans.modules.xml.xam.locator.CatalogModelFactory;
24 import org.openide.filesystems.FileObject;
25
26 /**
27  *
28  * @author Nam Nguyen
29  */
30 public abstract class CatalogWriteModelFactory extends CatalogModelFactory {
31     
32     /**
33      * Given a FileObject that belongs to a project this method will return a
34      * CatalogModel object specific to it.
35      * If there are initialization errors, CatalogModelException will be thrown.
36      * If FileOwnerQuery.getOwner(anyFileObjectExistingInAProject); returns null
37      * then assersion error will occur.
38      * @param anyFileObjectExistingInAProject any FileObject inside a project for which CatalogModel is needed
39      * @throws org.netbeans.modules.xml.xam.locator.api.CatalogModelException
40      */
41     public abstract CatalogWriteModel getCatalogWriteModelForProject(FileObject anyFileObjectExistingInAProject) throws CatalogModelException;
42     
43      /**
44      * Given a FileObject this method will return a CatalogWriteModel object specific to it.
45      * If there are initialization errors, CatalogModelException will be thrown.
46      * @param fileObjectOfCatalogFile any FileObject on which the catalog entries have to be created or appended.
47      * @throws org.netbeans.modules.xml.xam.locator.api.CatalogModelException
48      */
49     public abstract CatalogWriteModel getCatalogWriteModelForCatalogFile(FileObject fileObjectOfCatalogFile) throws CatalogModelException;
50     
51
52     private static CatalogWriteModelFactory implObj = null;
53     
54     public static CatalogWriteModelFactory getInstance(){
55         if(implObj == null) {
56             implObj = new CatalogModelFactoryImpl();
57         }
58         return implObj;
59     }
60 }
61
Popular Tags