com.sun.tools.xjc.outline.Outline Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.outline;
import java.util.Collection;
import com.sun.codemodel.JClass;
import com.sun.codemodel.JClassContainer;
import com.sun.codemodel.JCodeModel;
import com.sun.codemodel.JPackage;
import com.sun.codemodel.JType;
import com.sun.tools.xjc.ErrorReceiver;
import com.sun.tools.xjc.model.CClassInfo;
import com.sun.tools.xjc.model.CClassInfoParent;
import com.sun.tools.xjc.model.CElementInfo;
import com.sun.tools.xjc.model.CEnumLeafInfo;
import com.sun.tools.xjc.model.CPropertyInfo;
import com.sun.tools.xjc.model.CTypeRef;
import com.sun.tools.xjc.model.Model;
import com.sun.tools.xjc.util.CodeModelClassFactory;
/**
* Root of the outline. Captures which code is generated for which model component.
*
*
* This object also provides access to varioues utilities, such as
* error reporting etc, for the convenience of code that builds the outline.
*
* @author Kohsuke Kawaguchi
*/
public interface Outline
{
/**
* This outline is for this model.
*/
Model getModel();
/**
* Short for {@code getModel().codeModel}.
*/
JCodeModel getCodeModel();
/** Gets the object that wraps the generated field for a given {@link CPropertyInfo}. */
FieldOutline getField( CPropertyInfo fu );
/**
* Gets per-package context information.
*
* This method works for every visible package
* (those packages which are supposed to be used by client applications.)
*
* @return
* If this grammar doesn't produce anything in the specified
* package, return null.
*/
PackageOutline getPackageContext( JPackage _Package );
/**
* Returns all the {@link ClassOutline}s known to this object.
*/
Collection getClasses();
/**
* Obtains per-class context information.
*/
ClassOutline getClazz( CClassInfo clazz );
/**
* If the {@link CElementInfo} generates a class,
* returns such a class. Otherwise return null.
*/
ElementOutline getElement(CElementInfo ei);
EnumOutline getEnum(CEnumLeafInfo eli);
/**
* Gets all the {@link EnumOutline}s.
*/
Collection getEnums();
/** Gets all package-wise contexts at once. */
Iterable getAllPackageContexts();
/**
* Gets a reference to
* new CodeModelClassFactory(getErrorHandler()).
*/
CodeModelClassFactory getClassFactory();
/**
* Any error during the back-end proccessing should be
* sent to this object.
*/
ErrorReceiver getErrorReceiver();
JClassContainer getContainer(CClassInfoParent parent, Aspect aspect );
/**
* Resolves a type reference to the actual (possibly generated) type.
*
* Short for {@code resolve(ref.getType(),aspect)}.
*/
JType resolve(CTypeRef ref,Aspect aspect);
/**
* Copies the specified class into the user's package and returns
* a reference to it.
*/
JClass addRuntime(Class clazz);
}