01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.tools.xjc.outline;
38:
39: import com.sun.codemodel.JDefinedClass;
40: import com.sun.tools.xjc.model.CElementInfo;
41:
42: /**
43: * Outline object that provides per-{@link CElementInfo} information
44: * for filling in methods/fields for a bean.
45: *
46: * This interface is accessible from {@link Outline}. This object is
47: * not created for all {@link CElementInfo}s.
48: * It is only for those {@link CElementInfo} that has a class.
49: * (IOW, {@link CElementInfo#hasClass()}
50: *
51: * @author Kohsuke Kawaguchi
52: */
53: public abstract class ElementOutline {
54:
55: /**
56: * A {@link Outline} that encloses all the class outlines.
57: */
58: public abstract Outline parent();
59:
60: /**
61: * {@link PackageOutline} that contains this class.
62: */
63: public PackageOutline _package() {
64: return parent().getPackageContext(implClass._package());
65: }
66:
67: /**
68: * This {@link ElementOutline} holds information about this {@link CElementInfo}.
69: */
70: public final CElementInfo target;
71:
72: /**
73: * The implementation aspect of a bean.
74: * The actual place where fields/methods should be generated into.
75: */
76: public final JDefinedClass implClass;
77:
78: protected ElementOutline(CElementInfo target,
79: JDefinedClass implClass) {
80: this.target = target;
81: this.implClass = implClass;
82: }
83: }
|