001: /*
002: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package com.sun.tools.internal.xjc.outline;
027:
028: import java.util.Collection;
029:
030: import com.sun.codemodel.internal.JClass;
031: import com.sun.codemodel.internal.JClassContainer;
032: import com.sun.codemodel.internal.JCodeModel;
033: import com.sun.codemodel.internal.JPackage;
034: import com.sun.codemodel.internal.JType;
035: import com.sun.tools.internal.xjc.ErrorReceiver;
036: import com.sun.tools.internal.xjc.model.CClassInfo;
037: import com.sun.tools.internal.xjc.model.CClassInfoParent;
038: import com.sun.tools.internal.xjc.model.CElementInfo;
039: import com.sun.tools.internal.xjc.model.CEnumLeafInfo;
040: import com.sun.tools.internal.xjc.model.CPropertyInfo;
041: import com.sun.tools.internal.xjc.model.CTypeRef;
042: import com.sun.tools.internal.xjc.model.Model;
043: import com.sun.tools.internal.xjc.util.CodeModelClassFactory;
044:
045: /**
046: * Root of the outline. Captures which code is generated for which model component.
047: *
048: * <p>
049: * This object also provides access to varioues utilities, such as
050: * error reporting etc, for the convenience of code that builds the outline.
051: *
052: * @author Kohsuke Kawaguchi
053: */
054: public interface Outline {
055: /**
056: * This outline is for this model.
057: */
058: Model getModel();
059:
060: /**
061: * Short for {@code getModel().codeModel}.
062: */
063: JCodeModel getCodeModel();
064:
065: /** Gets the object that wraps the generated field for a given {@link CPropertyInfo}. */
066: FieldOutline getField(CPropertyInfo fu);
067:
068: /**
069: * Gets per-package context information.
070: *
071: * This method works for every visible package
072: * (those packages which are supposed to be used by client applications.)
073: *
074: * @return
075: * If this grammar doesn't produce anything in the specified
076: * package, return null.
077: */
078: PackageOutline getPackageContext(JPackage _Package);
079:
080: /**
081: * Returns all the {@link ClassOutline}s known to this object.
082: */
083: Collection<? extends ClassOutline> getClasses();
084:
085: /**
086: * Obtains per-class context information.
087: */
088: ClassOutline getClazz(CClassInfo clazz);
089:
090: /**
091: * If the {@link CElementInfo} generates a class,
092: * returns such a class. Otherwise return null.
093: */
094: ElementOutline getElement(CElementInfo ei);
095:
096: EnumOutline getEnum(CEnumLeafInfo eli);
097:
098: /**
099: * Gets all the {@link EnumOutline}s.
100: */
101: Collection<EnumOutline> getEnums();
102:
103: /** Gets all package-wise contexts at once. */
104: Iterable<? extends PackageOutline> getAllPackageContexts();
105:
106: /**
107: * Gets a reference to
108: * <code>new CodeModelClassFactory(getErrorHandler())</code>.
109: */
110: CodeModelClassFactory getClassFactory();
111:
112: /**
113: * Any error during the back-end proccessing should be
114: * sent to this object.
115: */
116: ErrorReceiver getErrorReceiver();
117:
118: JClassContainer getContainer(CClassInfoParent parent, Aspect aspect);
119:
120: /**
121: * Resolves a type reference to the actual (possibly generated) type.
122: *
123: * Short for {@code resolve(ref.getType(),aspect)}.
124: */
125: JType resolve(CTypeRef ref, Aspect aspect);
126:
127: /**
128: * Copies the specified class into the user's package and returns
129: * a reference to it.
130: */
131: JClass addRuntime(Class clazz);
132: }
|