| /* |
| * 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 |
| */ |
| |
| package com.sun.tools.xjc.model; |
| |
| import java.util.Collection; |
| |
| import jakarta.activation.MimeType; |
| import javax.xml.namespace.QName; |
| |
| import com.sun.codemodel.JClass; |
| import com.sun.codemodel.JExpression; |
| import com.sun.tools.xjc.model.nav.NClass; |
| import com.sun.tools.xjc.model.nav.NType; |
| import com.sun.tools.xjc.outline.Aspect; |
| import com.sun.tools.xjc.outline.Outline; |
| import org.glassfish.jaxb.core.v2.model.annotation.Locatable; |
| import org.glassfish.jaxb.core.v2.model.core.EnumLeafInfo; |
| import org.glassfish.jaxb.core.v2.model.core.ID; |
| import org.glassfish.jaxb.core.v2.model.core.NonElement; |
| import org.glassfish.jaxb.core.v2.model.core.Element; |
| import org.glassfish.jaxb.core.v2.runtime.Location; |
| import com.sun.xml.xsom.XSComponent; |
| import com.sun.xml.xsom.XmlString; |
| |
| import org.xml.sax.Locator; |
| |
| /** |
| * Transducer that converts a string into an "enumeration class." |
| * |
| * The structure of the generated class needs to precisely |
| * follow the JAXB spec. |
| * |
| * @author Kohsuke KAWAGUCHI |
| */ |
| public final class CEnumLeafInfo implements EnumLeafInfo<NType,NClass>, NClass, CNonElement |
| { |
| /** |
| * The {@link Model} object to which this bean belongs. |
| */ |
| public final Model model; |
| |
| /** |
| * The parent into which the enum class should be generated. |
| */ |
| public final CClassInfoParent parent; |
| |
| /** |
| * Short name of the generated type-safe enum. |
| */ |
| public final String shortName; |
| |
| private final QName typeName; |
| |
| private final XSComponent source; |
| |
| /** |
| * Represents the underlying type of this enumeration |
| * and its conversion. |
| * |
| * <p> |
| * To parse XML into a constant, we use the base type |
| * to do {@code lexical -> value}, then use a map to pick up the right one. |
| * |
| * <p> |
| * Hence this also represents the type of the Java value. |
| * For example, if this is an enumeration of xs:int, |
| * then this field will be Java int. |
| */ |
| public final CNonElement base; |
| |
| |
| /** |
| * List of enum members. |
| */ |
| public final Collection<CEnumConstant> members; |
| |
| private final CCustomizations customizations; |
| |
| /** |
| * @see #getLocator() |
| */ |
| private final Locator sourceLocator; |
| |
| public String javadoc; |
| |
| public CEnumLeafInfo(Model model, |
| QName typeName, |
| CClassInfoParent container, |
| String shortName, |
| CNonElement base, |
| Collection<CEnumConstant> _members, |
| XSComponent source, |
| CCustomizations customizations, |
| Locator _sourceLocator) { |
| this.model = model; |
| this.parent = container; |
| this.shortName = model.allocator.assignClassName(parent,shortName); |
| this.base = base; |
| this.members = _members; |
| this.source = source; |
| if(customizations==null) |
| customizations = CCustomizations.EMPTY; |
| this.customizations = customizations; |
| this.sourceLocator = _sourceLocator; |
| this.typeName = typeName; |
| |
| for( CEnumConstant mem : members ) |
| mem.setParent(this); |
| |
| model.add(this); |
| |
| // TODO: can we take advantage of the fact that enum can be XmlRootElement? |
| } |
| |
| /** |
| * Source line information that points to the place |
| * where this type-safe enum is defined. |
| * Used to report error messages. |
| */ |
| @Override |
| public Locator getLocator() { |
| return sourceLocator; |
| } |
| |
| @Override |
| public QName getTypeName() { |
| return typeName; |
| } |
| |
| @Override |
| public NType getType() { |
| return this; |
| } |
| |
| /** |
| * @deprecated |
| * why are you calling the method whose return value is known? |
| */ |
| @Deprecated |
| @Override |
| public boolean canBeReferencedByIDREF() { |
| return false; |
| } |
| |
| @Override |
| public boolean isElement() { |
| return false; |
| } |
| |
| @Override |
| public QName getElementName() { |
| return null; |
| } |
| |
| @Override |
| public Element<NType,NClass> asElement() { |
| return null; |
| } |
| |
| @Override |
| public NClass getClazz() { |
| return this; |
| } |
| |
| @Override |
| public XSComponent getSchemaComponent() { |
| return source; |
| } |
| |
| @Override |
| public JClass toType(Outline o, Aspect aspect) { |
| return o.getEnum(this).clazz; |
| } |
| |
| @Override |
| public boolean isAbstract() { |
| return false; |
| } |
| |
| @Override |
| public boolean isBoxedType() { |
| return false; |
| } |
| |
| @Override |
| public String fullName() { |
| return parent.fullName()+'.'+shortName; |
| } |
| |
| public boolean isPrimitive() { |
| return false; |
| } |
| |
| @Override |
| public boolean isSimpleType() { |
| return true; |
| } |
| |
| |
| /** |
| * The spec says the value field in the enum class will be generated |
| * only under certain circumstances. |
| * |
| * @return |
| * true if the generated enum class should have the value field. |
| */ |
| public boolean needsValueField() { |
| for (CEnumConstant cec : members) { |
| if(!cec.getName().equals(cec.getLexicalValue())) |
| return true; |
| } |
| return false; |
| } |
| |
| @Override |
| public JExpression createConstant(Outline outline, XmlString literal) { |
| // correctly identifying which constant it maps to is hard, so |
| // here I'm cheating |
| JClass type = toType(outline,Aspect.EXPOSED); |
| for (CEnumConstant mem : members) { |
| if(mem.getLexicalValue().equals(literal.value)) |
| return type.staticRef(mem.getName()); |
| } |
| return null; |
| } |
| |
| @Deprecated |
| @Override |
| public boolean isCollection() { |
| return false; |
| } |
| |
| @Deprecated |
| @Override |
| public CAdapter getAdapterUse() { |
| return null; |
| } |
| |
| @Deprecated |
| @Override |
| public CNonElement getInfo() { |
| return this; |
| } |
| |
| @Override |
| public ID idUse() { |
| return ID.NONE; |
| } |
| |
| @Override |
| public MimeType getExpectedMimeType() { |
| return null; |
| } |
| |
| @Override |
| public Collection<CEnumConstant> getConstants() { |
| return members; |
| } |
| |
| @Override |
| public NonElement<NType,NClass> getBaseType() { |
| return base; |
| } |
| |
| @Override |
| public CCustomizations getCustomizations() { |
| return customizations; |
| } |
| |
| @Override |
| public Locatable getUpstream() { |
| throw new UnsupportedOperationException(); |
| } |
| |
| @Override |
| public Location getLocation() { |
| throw new UnsupportedOperationException(); |
| } |
| } |