325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.tools.internal.xjc.api;
325N/A
325N/Aimport java.util.Collection;
325N/Aimport java.util.List;
325N/A
325N/Aimport javax.xml.namespace.QName;
325N/Aimport javax.xml.bind.annotation.XmlSeeAlso;
325N/A
325N/Aimport com.sun.codemodel.internal.CodeWriter;
325N/Aimport com.sun.codemodel.internal.JCodeModel;
325N/Aimport com.sun.codemodel.internal.JClass;
325N/Aimport com.sun.tools.internal.xjc.Options;
325N/Aimport com.sun.tools.internal.xjc.Plugin;
325N/A
325N/A/**
325N/A * {@link JAXBModel} that exposes additional information available
325N/A * only for the schema->java direction.
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Apublic interface S2JJAXBModel extends JAXBModel {
325N/A
325N/A /**
325N/A * Gets a {@link Mapping} object for the given global element.
325N/A *
325N/A * @return
325N/A * null if the element name is not a defined global element in the schema.
325N/A */
325N/A Mapping get( QName elementName );
325N/A
325N/A /**
325N/A * Gets all the <tt>ObjectFactory</tt> classes generated by the compilation.
325N/A *
325N/A * <p>
325N/A * This should be used for generating {@link XmlSeeAlso} on the SEI.
325N/A */
325N/A List<JClass> getAllObjectFactories();
325N/A
325N/A
325N/A /**
325N/A * Gets a read-only view of all the {@link Mapping}s.
325N/A */
325N/A Collection<? extends Mapping> getMappings();
325N/A
325N/A /**
325N/A * Returns the fully-qualified name of the Java type that is bound to the
325N/A * specified XML type.
325N/A *
325N/A * @param xmlTypeName
325N/A * must not be null.
325N/A * @return
325N/A * null if the XML type is not bound to any Java type.
325N/A */
325N/A TypeAndAnnotation getJavaType(QName xmlTypeName);
325N/A
325N/A /**
325N/A * Generates artifacts.
325N/A *
325N/A * <p>
325N/A * TODO: if JAXB supports various modes of code generations
325N/A * (such as public interface only or implementation only or
325N/A * etc), we should define bit flags to control those.
325N/A *
325N/A * <p>
325N/A * This operation is only supported for a model built from a schema.
325N/A *
325N/A * @param extensions
325N/A * The JAXB RI extensions to run. This can be null or empty
325N/A * array if the caller wishes not to run any extension.
325N/A * <br>
325N/A *
325N/A * Those specified extensions
325N/A * will participate in the code generation. Specifying an extension
325N/A * in this list has the same effect of turning that extension on
325N/A * via command line.
325N/A * <br>
325N/A *
325N/A * It is the caller's responsibility to configure each augmenter
325N/A * properly by using {@link Plugin#parseArgument(Options, String[], int)}.
325N/A *
325N/A * @return
325N/A * object filled with the generated code. Use
325N/A * {@link JCodeModel#build(CodeWriter)} to write them
325N/A * to a disk.
325N/A */
325N/A JCodeModel generateCode( Plugin[] extensions, ErrorListener errorListener );
325N/A}