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: * Portions Copyrighted 2007 Sun Microsystems, Inc.
27: */
28: package org.netbeans.modules.gsf.api;
29:
30: import java.util.Collection;
31: import java.util.Set;
32: import javax.swing.text.Document;
33:
34: /**
35: * An embedding model is used for files that have a GSF model embedded in some
36: * other language.
37: *
38: * @author Tor Norbye
39: */
40: public interface EmbeddingModel {
41: /** This model creates target source code of the given mime type */
42: String getTargetMimeType();
43:
44: /** This model is capable of translating to the {@link #getTargetMimeType}
45: * from the following source mime types.
46: */
47: Set<String> getSourceMimeTypes();
48:
49: /** Produce the source code (of mime type {@link #getTargetMimeType}
50: * from the given document (which must have outer mime type of one
51: * of the given {@link #getSourceMimeTypes}.
52: */
53: Collection<? extends TranslatedSource> translate(Document doc);
54: }
|