001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.core.filesystems;
043:
044: import java.io.*;
045: import java.util.*;
046:
047: import org.xml.sax.*;
048: import org.xml.sax.helpers.*;
049:
050: import org.openide.cookies.InstanceCookie;
051: import org.openide.loaders.*;
052: import org.openide.filesystems.*;
053: import org.openide.util.*;
054: import org.openide.util.lookup.*;
055: import org.openide.xml.*;
056: import org.openide.*;
057:
058: /**
059: * Default implementation providing Environment for XMLDataObject according to its
060: * public ID.
061: *
062: * <p>
063: * Subclass instance of this must be registered as <tt>FileEntityResolver</tt>
064: * dictates and must implement <tt>Environment.Provider</tt> interface.
065: *
066: * <p>
067: * It forever caches provided environment!
068: *
069: * @see org.netbeans.core.xml.FileEntityResolver
070: * @author Petr Kuzel
071: * @version
072: */
073: class XMLEnvironmentProvider extends SharedClassObject {
074:
075: private static final long serialVersionUID = 18947L;
076:
077: private static transient Map<FileObject, Lookup> envs = new HashMap<FileObject, Lookup>(
078: 11); // 11 expected number of modules using this
079:
080: // Environment.Provider ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
081:
082: /** Returns a lookup that represents environment.
083: * @return the lookup
084: */
085: public final Lookup getEnvironment(DataObject obj) {
086:
087: // the obj check is done by core FileEntityResolver that calls us
088:
089: // we want to create just one instance per FileObject
090:
091: FileObject file = obj.getPrimaryFile();
092: Lookup lookup = envs.get(file);
093: if (lookup == null) {
094: lookup = createLookup(obj);
095: envs.put(file, lookup);
096: }
097: return lookup;
098:
099: }
100:
101: /**
102: * It is called exactly once per DataObject.
103: *
104: * @return content of assigned Lookup
105: */
106: protected InstanceContent createInstanceContent(DataObject obj) {
107: return new InstanceContent();
108: }
109:
110: /**
111: * It is called exactly once per DataObject.
112: *
113: * @return Lookup containing <tt>createInstanceContent()</tt>
114: */
115: protected Lookup createLookup(DataObject obj) {
116: InstanceContent ic = createInstanceContent(obj);
117: Lookup lookup = new AbstractLookup(ic);
118: if (lookup.lookup(InstanceCookie.class) == null) {
119: Exceptions.printStackTrace(new IllegalStateException()); // instance cookie required
120: }
121: return lookup;
122: }
123:
124: }
|