com.sun.tools.xjc.outline.PackageOutline Maven / Gradle / Ivy
Show all versions of jaxb-xjc Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.outline;
import java.util.Set;
import javax.xml.bind.annotation.XmlNsForm;
import javax.xml.bind.annotation.XmlSchema;
import com.sun.codemodel.JDefinedClass;
import com.sun.codemodel.JPackage;
import com.sun.tools.xjc.generator.bean.ObjectFactoryGenerator;
/**
* Outline object that provides per-package information.
*
* This interface is accessible from {@link Outline}.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public interface PackageOutline {
/**
* The exposed package this context is representing.
*
*
* An exposed package is a package visible to users, a package
* supposed to be used by client applications. Sometime
* we have another parallel package that's not visible to users.
*/
JPackage _package();
/**
* Generated ObjectFactory from package.
*
* This method allows a caller to obtain a reference to such
* ObjectFactory from its package.
*
* Must not be null.
*/
JDefinedClass objectFactory();
/**
* Generates an ObjectFactory class for this package.
*/
ObjectFactoryGenerator objectFactoryGenerator();
/**
* Gets {@link ClassOutline}s whose {@link ClassOutline#_package()}
* points to this object.
*
* @return can be empty but never null.
*/
Set getClasses();
/**
* The namespace URI most commonly used in classes in this package.
* This should be used as the namespace URI for {@link XmlSchema#namespace()}.
*
*
* Null if no default
*/
public String getMostUsedNamespaceURI();
/**
* The element form default for this package.
*
* The value is computed by examining what would yield the smallest generated code.
*/
public XmlNsForm getElementFormDefault();
/**
* The attribute form default for this package.
*
* The value is computed by examining what would yield the smallest generated code.
*/
public XmlNsForm getAttributeFormDefault();
}