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:
42: package org.netbeans.modules.xml.xam;
43:
44: import org.openide.util.Lookup;
45:
46: /**
47: * This is the class that encapsulates the physical file for each model.
48: * @author girix
49: */
50: public class ModelSource implements Lookup.Provider {
51:
52: private Lookup lookup;
53: private boolean editable;
54:
55: /**
56: * Create a model source object given the lookup context. If editable is false
57: * the model cannot be mutated. Note that editable is static attribute of the
58: * model source, and does not reflect the access attribute of the associated file.
59: *
60: * @param lookup Lookup object associated with this ModelSource. Lookup minimally
61: * contains a File path of the backing file of the model and a javax.swing.text.Document object.
62: * @param editable whether the model is supposed to be mutated.
63: */
64: public ModelSource(Lookup lookup, boolean editable) {
65: this .editable = editable;
66: this .lookup = lookup;
67: }
68:
69: /**
70: * Returns the lookup object associated with this ModelSource. Lookup minimally
71: * contains a File absolute path or FileObject of the backing file of the model
72: * and javax.swing.text.Document object. If model is DOM, the lookup should
73: * also contains javax.xml.transform.Source object for use in cases of relative
74: * resolution of resource such as validation.
75: */
76: public Lookup getLookup() {
77: return lookup;
78: }
79:
80: /**
81: * States if the backing file can be edited.
82: * @return true if the model source file is writable.
83: */
84: public boolean isEditable() {
85: return editable;
86: }
87: }
|