ClassOutline.java
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* Use is subject to the license terms.
*/
package com.sun.tools.xjc.outline;
import java.util.List;
import com.sun.codemodel.JClass;
import com.sun.codemodel.JDefinedClass;
import com.sun.tools.xjc.model.CClassInfo;
import com.sun.tools.xjc.model.CCustomizable;
import com.sun.tools.xjc.model.CPropertyInfo;
import com.sun.istack.NotNull;
/**
* Outline object that provides per-{@link CClassInfo} information
* for filling in methods/fields for a bean.
*
* This interface is accessible from {@link Outline}
*
* @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*/
public abstract class ClassOutline implements CustomizableOutline {
/**
* A {@link Outline} that encloses all the class outlines.
*/
public abstract @NotNull Outline parent();
/**
* {@link PackageOutline} that contains this class.
*/
public @NotNull PackageOutline _package() {
return parent().getPackageContext(ref._package());
}
/**
* This {@link ClassOutline} holds information about this {@link CClassInfo}.
*/
public final @NotNull CClassInfo target;
/**
* The exposed aspect of the a bean.
*
* implClass is always assignable to this type.
* <p>
* Usually this is the public content interface, but
* it could be the same as the implClass.
*/
public final @NotNull JDefinedClass ref;
/**
* The implementation aspect of a bean.
* The actual place where fields/methods should be generated into.
*/
public final @NotNull JDefinedClass implClass;
/**
* The implementation class that shall be used for reference.
* <p>
* Usually this field holds the same value as the {@link #implClass} method,
* but sometimes it holds the user-specified implementation class
* when it is specified.
* <p>
* This is the type that needs to be used for generating fields.
*/
public final @NotNull JClass implRef;
protected ClassOutline( CClassInfo _target, JDefinedClass exposedClass, JClass implRef, JDefinedClass _implClass) {
this.target = _target;
this.ref = exposedClass;
this.implRef = implRef;
this.implClass = _implClass;
}
/**
* Gets all the {@link FieldOutline}s newly declared
* in this class.
*/
public final FieldOutline[] getDeclaredFields() {
List<CPropertyInfo> props = target.getProperties();
FieldOutline[] fr = new FieldOutline[props.size()];
for( int i=0; i<fr.length; i++ )
fr[i] = parent().getField(props.get(i));
return fr;
}
/**
* Returns the super class of this class, if it has the
* super class and it is also a JAXB-bound class.
* Otherwise null.
*/
public final ClassOutline getSuperClass() {
CClassInfo s = target.getBaseClass();
if(s==null) return null;
return parent().getClazz(s);
}
@Override
public JDefinedClass getImplClass() {
return implClass;
}
@Override
public CCustomizable getTarget() {
return target;
}
}