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.modules.spring.api.beans.model;
043:
044: import java.io.File;
045: import java.io.IOException;
046: import javax.swing.text.Document;
047: import javax.swing.text.Position.Bias;
048: import org.netbeans.modules.editor.NbEditorUtilities;
049: import org.netbeans.modules.spring.api.Action;
050: import org.netbeans.modules.spring.api.beans.ConfigFileGroup;
051: import org.netbeans.modules.spring.api.beans.SpringScope;
052: import org.netbeans.modules.spring.beans.SpringScopeAccessor;
053: import org.netbeans.modules.spring.beans.model.SpringConfigFileModelController.LockedDocument;
054: import org.netbeans.modules.spring.beans.model.SpringConfigModelController;
055: import org.openide.filesystems.FileObject;
056: import org.openide.text.PositionRef;
057:
058: /**
059: * Encapsulates a model of Spring configuration files.
060: *
061: * @author Andrei Badea
062: */
063: public final class SpringConfigModel {
064:
065: private final SpringConfigModelController controller;
066:
067: /**
068: * Returns a Spring configuration model for the given file.
069: *
070: * @param file a file; never null.
071: * @return a Spring configuration model or null
072: */
073: public static SpringConfigModel forFileObject(FileObject file) {
074: SpringScope scope = SpringScope.getSpringScope(file);
075: if (scope != null) {
076: return SpringScopeAccessor.DEFAULT.getConfigModel(scope,
077: file);
078: }
079: return null;
080: }
081:
082: // XXX should not be public.
083: public SpringConfigModel(ConfigFileGroup configFileGroup) {
084: controller = SpringConfigModelController
085: .create(configFileGroup);
086: }
087:
088: /**
089: * Provides access to the model. This method expects an {@link Action}
090: * whose run method will be passed an instance of {@link SpringBeans}.
091: *
092: * <p><strong>All clients must make sure that no objects obtained from
093: * the {@code SpringBeans} instance "escape" the {@code run()} method, in the
094: * sense that they are reachable when the {@code run()} method has
095: * finished running.</strong></p>
096: *
097: * @param action
098: */
099: public void runReadAction(final Action<SpringBeans> action)
100: throws IOException {
101: controller.runReadAction(action);
102: }
103:
104: public void runDocumentAction(Action<DocumentAccess> action)
105: throws IOException {
106: controller.runDocumentAction(action);
107: }
108:
109: // XXX remove public constructor.
110: public static final class DocumentAccess {
111:
112: private final SpringBeans springBeans;
113: private final LockedDocument lockedDoc;
114: private final File file;
115:
116: public DocumentAccess(SpringBeans springBeans, File file,
117: LockedDocument lockedDoc) {
118: this .springBeans = springBeans;
119: this .lockedDoc = lockedDoc;
120: this .file = file;
121: }
122:
123: public SpringBeans getSpringBeans() {
124: return springBeans;
125: }
126:
127: public Document getDocument() {
128: return lockedDoc.getDocument();
129: }
130:
131: public File getFile() {
132: return file;
133: }
134:
135: public FileObject getFileObject() {
136: return NbEditorUtilities.getFileObject(lockedDoc
137: .getDocument());
138: }
139:
140: public PositionRef createPositionRef(int offset, Bias bias) {
141: return lockedDoc.createPositionRef(offset, bias);
142: }
143: }
144: }
|