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.model.nav;
38:
39: import com.sun.codemodel.JType;
40: import com.sun.tools.xjc.outline.Aspect;
41: import com.sun.tools.xjc.outline.Outline;
42:
43: /**
44: * A type.
45: *
46: * See the package documentaion for details.
47: *
48: * @author Kohsuke Kawaguchi
49: */
50: public interface NType {
51: /**
52: * Returns the representation of this type in code model.
53: * <p>
54: * This operation requires the whole model to be built,
55: * and hence it takes {@link Outline}.
56: * <p>
57: * Under some code generation strategy, some bean classes
58: * are considered implementation specific (such as impl.FooImpl class)
59: * These classes always have accompanying "exposed" type (such as
60: * the Foo interface).
61: * <p>
62: * For such Jekyll and Hyde type, the aspect parameter determines
63: * which personality is returned.
64: *
65: * @param aspect
66: * If {@link Aspect#IMPLEMENTATION}, this method returns the
67: * implementation specific class that this type represents.
68: * If {@link Aspect#EXPOSED}, this method returns the
69: * publicly exposed type that this type represents.
70: *
71: * For ordinary classes, the aspect parameter is meaningless.
72: *
73: */
74: JType toType(Outline o, Aspect aspect);
75:
76: /**
77: * Returns true iff this type represents a class that has a unboxed form.
78: *
79: * For example, for {@link String} this is false, but for {@link Integer}
80: * this is true.
81: */
82: boolean isBoxedType();
83:
84: /**
85: * Human readable name of this type.
86: */
87: String fullName();
88: }
|