01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.internal.xjc.outline;
27:
28: import java.util.Set;
29:
30: import javax.xml.bind.annotation.XmlNsForm;
31: import javax.xml.bind.annotation.XmlSchema;
32:
33: import com.sun.codemodel.internal.JDefinedClass;
34: import com.sun.codemodel.internal.JPackage;
35: import com.sun.tools.internal.xjc.generator.bean.ObjectFactoryGenerator;
36:
37: /**
38: * Outline object that provides per-package information.
39: *
40: * This interface is accessible from {@link Outline}.
41: *
42: * @author
43: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
44: */
45: public interface PackageOutline {
46:
47: /**
48: * The exposed package this context is representing.
49: *
50: * <p>
51: * An exposed package is a package visible to users, a package
52: * supposed to be used by client applications. Sometime
53: * we have another parallel package that's not visible to users.
54: */
55: JPackage _package();
56:
57: /**
58: * Generated ObjectFactory from package.
59: *
60: * This method allows a caller to obtain a reference to such
61: * ObjectFactory from its package.
62: *
63: * Must not be null.
64: */
65: JDefinedClass objectFactory();
66:
67: /**
68: * Generates an ObjectFactory class for this package.
69: */
70: ObjectFactoryGenerator objectFactoryGenerator();
71:
72: /**
73: * Gets {@link ClassOutline}s whose {@link ClassOutline#_package()}
74: * points to this object.
75: *
76: * @return can be empty but never null.
77: */
78: Set<? extends ClassOutline> getClasses();
79:
80: /**
81: * The namespace URI most commonly used in classes in this package.
82: * This should be used as the namespace URI for {@link XmlSchema#namespace()}.
83: *
84: * <p>
85: * Null if no default
86: */
87: public String getMostUsedNamespaceURI();
88:
89: /**
90: * The element form default for this package.
91: * <p>
92: * The value is computed by examining what would yield the smallest generated code.
93: */
94: public XmlNsForm getElementFormDefault();
95:
96: }
|