org.glassfish.jaxb.runtime.v2.model.impl.TypeInfoSetImpl Maven / Gradle / Ivy
Show all versions of jaxb-runtime Show documentation
/*
* Copyright (c) 1997, 2020 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 org.glassfish.jaxb.runtime.v2.model.impl;
import org.glassfish.jaxb.core.v2.model.annotation.AnnotationReader;
import org.glassfish.jaxb.core.v2.model.core.*;
import org.glassfish.jaxb.core.v2.model.nav.Navigator;
import org.glassfish.jaxb.core.v2.runtime.IllegalAnnotationException;
import org.glassfish.jaxb.core.v2.runtime.RuntimeUtil;
import org.glassfish.jaxb.core.v2.util.FlattenIterator;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;
import jakarta.xml.bind.annotation.*;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import javax.xml.namespace.QName;
import javax.xml.transform.Result;
import java.util.*;
/**
* Set of {@link TypeInfo}s.
*
*
* This contains a fixed set of {@link LeafInfo}s and arbitrary set of {@link ClassInfo}s.
*
*
* Members are annotated with JAXB annotations so that we can dump it easily.
*
* @author Kohsuke Kawaguchi
*/
class TypeInfoSetImpl implements TypeInfoSet {
@XmlTransient
public final Navigator nav;
@XmlTransient
public final AnnotationReader reader;
/**
* All the leaves.
*/
private final Map> builtins =
new LinkedHashMap>();
/** All {@link EnumLeafInfoImpl}s. */
private final Map> enums =
new LinkedHashMap>();
/** All {@link ArrayInfoImpl}s. */
private final Map> arrays =
new LinkedHashMap>();
/**
* All the user-defined classes.
*
* Using {@link LinkedHashMap} allows us to process classes
* in the order they are given to us. When the user incorrectly
* puts an unexpected class into a reference graph, this causes
* an error to be reported on a class closer to the user's code.
*/
@XmlJavaTypeAdapter(RuntimeUtil.ToStringAdapter.class)
private final Map> beans
= new LinkedHashMap>();
@XmlTransient
private final Map> beansView =
Collections.unmodifiableMap(beans);
/**
* The element mapping.
*/
private final Map>> elementMappings =
new LinkedHashMap>>();
private final Iterable> allElements =
new Iterable>() {
public Iterator> iterator() {
return new FlattenIterator>(elementMappings.values());
}
};
/**
* {@link TypeInfo} for {@code xs:anyType}.
*
* anyType is the only {@link TypeInfo} that works with an interface,
* and accordingly it requires a lot of special casing.
*/
private final NonElement anyType;
/**
* Lazily parsed set of {@link XmlNs}s.
*
* @see #getXmlNs(String)
*/
private Map> xmlNsCache;
public TypeInfoSetImpl(Navigator nav,
AnnotationReader reader,
Map> leaves) {
this.nav = nav;
this.reader = reader;
this.builtins.putAll(leaves);
this.anyType = createAnyType();
// register primitive types.
for (Map.Entry e : RuntimeUtil.primitiveToBox.entrySet()) {
this.builtins.put( nav.getPrimitive(e.getKey()), leaves.get(nav.ref(e.getValue())) );
}
// make sure at lease we got a map for global ones.
elementMappings.put(null,new LinkedHashMap>());
}
protected NonElement createAnyType() {
return new AnyTypeImpl(nav);
}
public Navigator getNavigator() {
return nav;
}
/**
* Adds a new {@link ClassInfo} to the set.
*/
public void add( ClassInfoImpl ci ) {
beans.put( ci.getClazz(), ci );
}
/**
* Adds a new {@link LeafInfo} to the set.
*/
public void add( EnumLeafInfoImpl li ) {
enums.put( li.clazz, li );
}
public void add(ArrayInfoImpl ai) {
arrays.put( ai.getType(), ai );
}
/**
* Returns a {@link TypeInfo} for the given type.
*
* @return
* null if the specified type cannot be bound by JAXB, or
* not known to this set.
*/
public NonElement getTypeInfo( T type ) {
type = nav.erasure(type); // replace type variables by their bounds
LeafInfo l = builtins.get(type);
if(l!=null) return l;
if( nav.isArray(type) ) {
return arrays.get(type);
}
C d = nav.asDecl(type);
if(d==null) return null;
return getClassInfo(d);
}
public NonElement getAnyTypeInfo() {
return anyType;
}
/**
* This method is used to add a root reference to a model.
*/
public NonElement getTypeInfo(Ref ref) {
// TODO: handle XmlValueList
assert !ref.valueList;
C c = nav.asDecl(ref.type);
if(c!=null && reader.getClassAnnotation(XmlRegistry.class,c,null/*TODO: is this right?*/)!=null) {
return null; // TODO: is this correct?
} else
return getTypeInfo(ref.type);
}
/**
* Returns all the {@link ClassInfo}s known to this set.
*/
public Map> beans() {
return beansView;
}
public Map> builtins() {
return builtins;
}
public Map> enums() {
return enums;
}
public Map> arrays() {
return arrays;
}
/**
* Returns a {@link ClassInfo} for the given bean.
*
*
* This method is almost like refinement of {@link #getTypeInfo(Object)} except
* our C cannot derive from T.
*
* @return
* null if the specified type is not bound by JAXB or otherwise
* unknown to this set.
*/
public NonElement getClassInfo( C type ) {
LeafInfo l = builtins.get(nav.use(type));
if(l!=null) return l;
l = enums.get(type);
if(l!=null) return l;
if(nav.asDecl(Object.class).equals(type))
return anyType;
return beans.get(type);
}
public ElementInfoImpl getElementInfo( C scope, QName name ) {
while(scope!=null) {
Map> m = elementMappings.get(scope);
if(m!=null) {
ElementInfoImpl r = m.get(name);
if(r!=null) return r;
}
scope = nav.getSuperClass(scope);
}
return elementMappings.get(null).get(name);
}
/**
* @param builder
* used for reporting errors.
*/
public final void add( ElementInfoImpl ei, ModelBuilder builder ) {
C scope = null;
if(ei.getScope()!=null)
scope = ei.getScope().getClazz();
Map> m = elementMappings.get(scope);
if(m==null)
elementMappings.put(scope,m=new LinkedHashMap>());
ElementInfoImpl existing = m.put(ei.getElementName(),ei);
if(existing!=null) {
QName en = ei.getElementName();
builder.reportError(
new IllegalAnnotationException(
Messages.CONFLICTING_XML_ELEMENT_MAPPING.format(en.getNamespaceURI(),en.getLocalPart()),
ei, existing ));
}
}
public Map> getElementMappings( C scope ) {
return elementMappings.get(scope);
}
public Iterable> getAllElements() {
return allElements;
}
public Map getXmlNs(String namespaceUri) {
if(xmlNsCache==null) {
xmlNsCache = new HashMap>();
for (ClassInfoImpl ci : beans().values()) {
XmlSchema xs = reader.getPackageAnnotation( XmlSchema.class, ci.getClazz(), null );
if(xs==null)
continue;
String uri = xs.namespace();
Map m = xmlNsCache.get(uri);
if(m==null)
xmlNsCache.put(uri,m=new HashMap());
for( XmlNs xns : xs.xmlns() ) {
m.put(xns.prefix(),xns.namespaceURI());
}
}
}
Map r = xmlNsCache.get(namespaceUri);
if(r!=null) return r;
else return Collections.emptyMap();
}
public Map getSchemaLocations() {
Map r = new HashMap();
for (ClassInfoImpl ci : beans().values()) {
XmlSchema xs = reader.getPackageAnnotation( XmlSchema.class, ci.getClazz(), null );
if(xs==null)
continue;
String loc = xs.location();
if(loc.equals(XmlSchema.NO_LOCATION))
continue; // unspecified
r.put(xs.namespace(),loc);
}
return r;
}
public final XmlNsForm getElementFormDefault(String nsUri) {
for (ClassInfoImpl ci : beans().values()) {
XmlSchema xs = reader.getPackageAnnotation( XmlSchema.class, ci.getClazz(), null );
if(xs==null)
continue;
if(!xs.namespace().equals(nsUri))
continue;
XmlNsForm xnf = xs.elementFormDefault();
if(xnf!=XmlNsForm.UNSET)
return xnf;
}
return XmlNsForm.UNSET;
}
public final XmlNsForm getAttributeFormDefault(String nsUri) {
for (ClassInfoImpl ci : beans().values()) {
XmlSchema xs = reader.getPackageAnnotation( XmlSchema.class, ci.getClazz(), null );
if(xs==null)
continue;
if(!xs.namespace().equals(nsUri))
continue;
XmlNsForm xnf = xs.attributeFormDefault();
if(xnf!=XmlNsForm.UNSET)
return xnf;
}
return XmlNsForm.UNSET;
}
/**
* Dumps this model into XML.
*
* For debug only.
*
* TODO: not sure if this actually works. We don't really know what are T,C.
*/
public void dump( Result out ) throws JAXBException {
JAXBContext context = JAXBContext.newInstance(this.getClass());
Marshaller m = context.createMarshaller();
m.marshal(this,out);
}
}