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.Collection;
039:
040: import com.sun.codemodel.JClass;
041: import com.sun.codemodel.JClassContainer;
042: import com.sun.codemodel.JCodeModel;
043: import com.sun.codemodel.JPackage;
044: import com.sun.codemodel.JType;
045: import com.sun.tools.xjc.ErrorReceiver;
046: import com.sun.tools.xjc.model.CClassInfo;
047: import com.sun.tools.xjc.model.CClassInfoParent;
048: import com.sun.tools.xjc.model.CElementInfo;
049: import com.sun.tools.xjc.model.CEnumLeafInfo;
050: import com.sun.tools.xjc.model.CPropertyInfo;
051: import com.sun.tools.xjc.model.CTypeRef;
052: import com.sun.tools.xjc.model.Model;
053: import com.sun.tools.xjc.util.CodeModelClassFactory;
054:
055: /**
056: * Root of the outline. Captures which code is generated for which model component.
057: *
058: * <p>
059: * This object also provides access to varioues utilities, such as
060: * error reporting etc, for the convenience of code that builds the outline.
061: *
062: * @author Kohsuke Kawaguchi
063: */
064: public interface Outline {
065: /**
066: * This outline is for this model.
067: */
068: Model getModel();
069:
070: /**
071: * Short for {@code getModel().codeModel}.
072: */
073: JCodeModel getCodeModel();
074:
075: /** Gets the object that wraps the generated field for a given {@link CPropertyInfo}. */
076: FieldOutline getField(CPropertyInfo fu);
077:
078: /**
079: * Gets per-package context information.
080: *
081: * This method works for every visible package
082: * (those packages which are supposed to be used by client applications.)
083: *
084: * @return
085: * If this grammar doesn't produce anything in the specified
086: * package, return null.
087: */
088: PackageOutline getPackageContext(JPackage _Package);
089:
090: /**
091: * Returns all the {@link ClassOutline}s known to this object.
092: */
093: Collection<? extends ClassOutline> getClasses();
094:
095: /**
096: * Obtains per-class context information.
097: */
098: ClassOutline getClazz(CClassInfo clazz);
099:
100: /**
101: * If the {@link CElementInfo} generates a class,
102: * returns such a class. Otherwise return null.
103: */
104: ElementOutline getElement(CElementInfo ei);
105:
106: EnumOutline getEnum(CEnumLeafInfo eli);
107:
108: /**
109: * Gets all the {@link EnumOutline}s.
110: */
111: Collection<EnumOutline> getEnums();
112:
113: /** Gets all package-wise contexts at once. */
114: Iterable<? extends PackageOutline> getAllPackageContexts();
115:
116: /**
117: * Gets a reference to
118: * <code>new CodeModelClassFactory(getErrorHandler())</code>.
119: */
120: CodeModelClassFactory getClassFactory();
121:
122: /**
123: * Any error during the back-end proccessing should be
124: * sent to this object.
125: */
126: ErrorReceiver getErrorReceiver();
127:
128: JClassContainer getContainer(CClassInfoParent parent, Aspect aspect);
129:
130: /**
131: * Resolves a type reference to the actual (possibly generated) type.
132: *
133: * Short for {@code resolve(ref.getType(),aspect)}.
134: */
135: JType resolve(CTypeRef ref, Aspect aspect);
136:
137: /**
138: * Copies the specified class into the user's package and returns
139: * a reference to it.
140: */
141: JClass addRuntime(Class clazz);
142: }
|