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 Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package com.sun.tools.xjc.outline;
037:
038: import java.util.Set;
039:
040: import javax.xml.bind.annotation.XmlNsForm;
041: import javax.xml.bind.annotation.XmlSchema;
042:
043: import com.sun.codemodel.JDefinedClass;
044: import com.sun.codemodel.JPackage;
045: import com.sun.tools.xjc.generator.bean.ObjectFactoryGenerator;
046:
047: /**
048: * Outline object that provides per-package information.
049: *
050: * This interface is accessible from {@link Outline}.
051: *
052: * @author
053: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
054: */
055: public interface PackageOutline {
056:
057: /**
058: * The exposed package this context is representing.
059: *
060: * <p>
061: * An exposed package is a package visible to users, a package
062: * supposed to be used by client applications. Sometime
063: * we have another parallel package that's not visible to users.
064: */
065: JPackage _package();
066:
067: /**
068: * Generated ObjectFactory from package.
069: *
070: * This method allows a caller to obtain a reference to such
071: * ObjectFactory from its package.
072: *
073: * Must not be null.
074: */
075: JDefinedClass objectFactory();
076:
077: /**
078: * Generates an ObjectFactory class for this package.
079: */
080: ObjectFactoryGenerator objectFactoryGenerator();
081:
082: /**
083: * Gets {@link ClassOutline}s whose {@link ClassOutline#_package()}
084: * points to this object.
085: *
086: * @return can be empty but never null.
087: */
088: Set<? extends ClassOutline> getClasses();
089:
090: /**
091: * The namespace URI most commonly used in classes in this package.
092: * This should be used as the namespace URI for {@link XmlSchema#namespace()}.
093: *
094: * <p>
095: * Null if no default
096: */
097: public String getMostUsedNamespaceURI();
098:
099: /**
100: * The element form default for this package.
101: * <p>
102: * The value is computed by examining what would yield the smallest generated code.
103: */
104: public XmlNsForm getElementFormDefault();
105:
106: }
|