01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.xml.retriever.catalog;
42:
43: import org.netbeans.modules.xml.retriever.catalog.impl.CatalogModelFactoryImpl;
44: import org.netbeans.modules.xml.xam.locator.CatalogModelException;
45: import org.netbeans.modules.xml.xam.locator.CatalogModelFactory;
46: import org.openide.filesystems.FileObject;
47:
48: /**
49: *
50: * @author Nam Nguyen
51: */
52: public abstract class CatalogWriteModelFactory extends
53: CatalogModelFactory {
54:
55: /**
56: * Given a FileObject that belongs to a project this method will return a
57: * CatalogModel object specific to it.
58: * If there are initialization errors, CatalogModelException will be thrown.
59: * If FileOwnerQuery.getOwner(anyFileObjectExistingInAProject); returns null
60: * then assersion error will occur.
61: * @param anyFileObjectExistingInAProject any FileObject inside a project for which CatalogModel is needed
62: * @throws org.netbeans.modules.xml.xam.locator.api.CatalogModelException
63: */
64: public abstract CatalogWriteModel getCatalogWriteModelForProject(
65: FileObject anyFileObjectExistingInAProject)
66: throws CatalogModelException;
67:
68: /**
69: * Given a FileObject this method will return a CatalogWriteModel object specific to it.
70: * If there are initialization errors, CatalogModelException will be thrown.
71: * @param fileObjectOfCatalogFile any FileObject on which the catalog entries have to be created or appended.
72: * @throws org.netbeans.modules.xml.xam.locator.api.CatalogModelException
73: */
74: public abstract CatalogWriteModel getCatalogWriteModelForCatalogFile(
75: FileObject fileObjectOfCatalogFile)
76: throws CatalogModelException;
77:
78: private static CatalogWriteModelFactory implObj = null;
79:
80: public static CatalogWriteModelFactory getInstance() {
81: if (implObj == null) {
82: implObj = new CatalogModelFactoryImpl();
83: }
84: return implObj;
85: }
86: }
|