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 com.sun.codemodel.internal.JDefinedClass;
29: import com.sun.tools.internal.xjc.model.CElementInfo;
30:
31: /**
32: * Outline object that provides per-{@link CElementInfo} information
33: * for filling in methods/fields for a bean.
34: *
35: * This interface is accessible from {@link Outline}. This object is
36: * not created for all {@link CElementInfo}s.
37: * It is only for those {@link CElementInfo} that has a class.
38: * (IOW, {@link CElementInfo#hasClass()}
39: *
40: * @author Kohsuke Kawaguchi
41: */
42: public abstract class ElementOutline {
43:
44: /**
45: * A {@link Outline} that encloses all the class outlines.
46: */
47: public abstract Outline parent();
48:
49: /**
50: * {@link PackageOutline} that contains this class.
51: */
52: public PackageOutline _package() {
53: return parent().getPackageContext(implClass._package());
54: }
55:
56: /**
57: * This {@link ElementOutline} holds information about this {@link CElementInfo}.
58: */
59: public final CElementInfo target;
60:
61: /**
62: * The implementation aspect of a bean.
63: * The actual place where fields/methods should be generated into.
64: */
65: public final JDefinedClass implClass;
66:
67: protected ElementOutline(CElementInfo target,
68: JDefinedClass implClass) {
69: this.target = target;
70: this.implClass = implClass;
71: }
72: }
|