001: /*
002: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.internal.xjc.api;
027:
028: import java.util.Collection;
029:
030: import javax.xml.namespace.QName;
031:
032: import com.sun.codemodel.internal.CodeWriter;
033: import com.sun.codemodel.internal.JCodeModel;
034: import com.sun.tools.internal.xjc.Options;
035: import com.sun.tools.internal.xjc.Plugin;
036:
037: /**
038: * {@link JAXBModel} that exposes additional information available
039: * only for the schema->java direction.
040: *
041: * @author Kohsuke Kawaguchi
042: */
043: public interface S2JJAXBModel extends JAXBModel {
044:
045: /**
046: * Gets a {@link Mapping} object for the given global element.
047: *
048: * @return
049: * null if the element name is not a defined global element in the schema.
050: */
051: Mapping get(QName elementName);
052:
053: /**
054: * Gets a read-only view of all the {@link Mapping}s.
055: */
056: Collection<? extends Mapping> getMappings();
057:
058: /**
059: * Returns the fully-qualified name of the Java type that is bound to the
060: * specified XML type.
061: *
062: * @param xmlTypeName
063: * must not be null.
064: * @return
065: * null if the XML type is not bound to any Java type.
066: */
067: TypeAndAnnotation getJavaType(QName xmlTypeName);
068:
069: /**
070: * Generates artifacts.
071: *
072: * <p>
073: * TODO: if JAXB supports various modes of code generations
074: * (such as public interface only or implementation only or
075: * etc), we should define bit flags to control those.
076: *
077: * <p>
078: * This operation is only supported for a model built from a schema.
079: *
080: * @param extensions
081: * The JAXB RI extensions to run. This can be null or empty
082: * array if the caller wishes not to run any extension.
083: * <br>
084: *
085: * Those specified extensions
086: * will participate in the code generation. Specifying an extension
087: * in this list has the same effect of turning that extension on
088: * via command line.
089: * <br>
090: *
091: * It is the caller's responsibility to configure each augmenter
092: * properly by using {@link Plugin#parseArgument(Options, String[], int)}.
093: *
094: * @return
095: * object filled with the generated code. Use
096: * {@link JCodeModel#build(CodeWriter)} to write them
097: * to a disk.
098: */
099: JCodeModel generateCode(Plugin[] extensions,
100: ErrorListener errorListener);
101: }
|