- java.lang.Object
-
- com.sun.tools.xjc.model.Model
-
- All Implemented Interfaces:
CCustomizable,TypeInfoSet<NType,NClass,Void,Void>
public final class Model extends Object implements TypeInfoSet<NType,NClass,Void,Void>, CCustomizable
Root of the object model that represents the code that needs to be generated.A
Modelis a schema language neutral representation of the result of a schema parsing. The back-end then works against this model to turn this into a series of Java source code.- Author:
- Kohsuke Kawaguchi
-
-
Field Summary
Fields Modifier and Type Field Description JCodeModelcodeModelThis model uses this code model exclusively.SymbolSpacedefaultSymbolSpaceDefault ID/IDREF symbol space.OptionsoptionsCommand-line options used for building this model.JClassrootClassIf non-null, all the generated classes should eventually derive from this class.JClassrootInterfaceIf non-null, all the generated interfaces should eventually derive from this interface.XSSchemaSetschemaComponentIf this model was built from XML Schema, this field stores the root object of the parse schema model.booleanserializableTrue to generate serializable classes.LongserialVersionUIDserial version UID to be generated.ImplStructureStrategystrategySpecifies the code generation strategy.
-
Constructor Summary
Constructors Constructor Description Model(Options opts, JCodeModel cm, NameConverter nc, ClassNameAllocator allocator, XSSchemaSet schemaComponent)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Map<NType,? extends CArrayInfo>arrays()No array mapping generation for XJC.Map<NClass,CClassInfo>beans()Returns all theClassInfos known to this set.Map<NType,? extends CBuiltinLeafInfo>builtins()Returns all theBuiltinLeafInfos known to this set.Map<QName,CClassInfo>createTopLevelBindings()Represents the "top-level binding".voiddump(Result out)Dumps this model into XML.Map<NClass,CEnumLeafInfo>enums()Returns all theEnumLeafInfos known to this set.OutlinegenerateCode(Options opt, ErrorReceiver receiver)Fully-generate the source code into the given model.Iterable<? extends CElementInfo>getAllElements()Returns all theElementInfoknown to this set.CBuiltinLeafInfogetAnyTypeInfo()Gets theTypeInfofor the any type.jakarta.xml.bind.annotation.XmlNsFormgetAttributeFormDefault(String nsUri)Gets the reasonableXmlNsFormfor the given namespace URI.CClassInfogetClassInfo(NClass t)CCustomizationsgetCustomizations()Gets the global customizations.jakarta.xml.bind.annotation.XmlNsFormgetElementFormDefault(String nsUri)Gets the reasonableXmlNsFormfor the given namespace URI.CElementInfogetElementInfo(NClass scope, QName name)Returns aElementInfofor the given element.Map<QName,CElementInfo>getElementMappings(NClass scope)Returns allElementInfos in the given scope.LocatorgetLocator()Deprecated.No line number available for the "root" component.NameConvertergetNameConverter()Gets the name converter that shall be used to parse XML names into Java names.Navigator<NType,NClass,Void,Void>getNavigator()Navigatorfor this model.CClassInfoParent.PackagegetPackage(JPackage pkg)XSComponentgetSchemaComponent()Deprecated.Always return null.Map<String,String>getSchemaLocations()GetsXmlSchema.location()found in this context.SymbolSpacegetSymbolSpace(String name)CNonElementgetTypeInfo(NType type)Returns aTypeInfofor the given type.CNonElementgetTypeInfo(Ref<NType,NClass> ref)Returns a type information for the given reference.Map<String,String>getXmlNs(String namespaceUri)Not implemented in the compile-time model.booleanisPackageLevelAnnotations()voidsetNameConverter(NameConverter nameConverter)voidsetPackageLevelAnnotations(boolean packageLevelAnnotations)Map<QName,TypeUse>typeUses()
-
-
-
Field Detail
-
schemaComponent
public final XSSchemaSet schemaComponent
If this model was built from XML Schema, this field stores the root object of the parse schema model. Otherwise null.- Since:
- 2.1.1
-
codeModel
public final JCodeModel codeModel
This model uses this code model exclusively.
-
options
public final Options options
Command-line options used for building this model.
-
serializable
public boolean serializable
True to generate serializable classes.
-
serialVersionUID
public Long serialVersionUID
serial version UID to be generated. null if not to generate serialVersionUID field.
-
rootClass
public JClass rootClass
If non-null, all the generated classes should eventually derive from this class.
-
rootInterface
public JClass rootInterface
If non-null, all the generated interfaces should eventually derive from this interface.
-
strategy
public ImplStructureStrategy strategy
Specifies the code generation strategy. Must not be null.
-
defaultSymbolSpace
public final SymbolSpace defaultSymbolSpace
Default ID/IDREF symbol space. Any ID/IDREF without explicit reference to a symbol space is assumed to use this default symbol space.
-
-
Constructor Detail
-
Model
public Model(Options opts, JCodeModel cm, NameConverter nc, ClassNameAllocator allocator, XSSchemaSet schemaComponent)
- Parameters:
nc- Usually this should be set in the constructor, but we do allow this parameter to be initially null, and then set later.schemaComponent- The source schema model, if this is built from XSD.
-
-
Method Detail
-
setNameConverter
public void setNameConverter(NameConverter nameConverter)
-
getNameConverter
public final NameConverter getNameConverter()
Gets the name converter that shall be used to parse XML names into Java names.
-
isPackageLevelAnnotations
public boolean isPackageLevelAnnotations()
-
setPackageLevelAnnotations
public void setPackageLevelAnnotations(boolean packageLevelAnnotations)
-
getSymbolSpace
public SymbolSpace getSymbolSpace(String name)
-
generateCode
public Outline generateCode(Options opt, ErrorReceiver receiver)
Fully-generate the source code into the given model.- Returns:
- null if there was any errors. Otherwise it returns a valid
Outlineobject, which captures how the model objects are mapped to the generated source code.Add-ons can use those information to further augment the generated source code.
-
createTopLevelBindings
public final Map<QName,CClassInfo> createTopLevelBindings()
Represents the "top-level binding".This is used to support the use of a schema inside WSDL. For XML Schema, the top-level binding is a map from global element declarations to its representation class.
For other schema languages, it should follow the appendices in WSDL (but in practice no one would use WSDL with a schema language other than XML Schema, so it doesn't really matter.)
This needs to be filled by the front-end.
-
getNavigator
public Navigator<NType,NClass,Void,Void> getNavigator()
Description copied from interface:TypeInfoSetNavigatorfor this model.- Specified by:
getNavigatorin interfaceTypeInfoSet<NType,NClass,Void,Void>
-
getTypeInfo
public CNonElement getTypeInfo(NType type)
Description copied from interface:TypeInfoSetReturns aTypeInfofor the given type.- Specified by:
getTypeInfoin interfaceTypeInfoSet<NType,NClass,Void,Void>- Returns:
- null if the specified type cannot be bound by JAXB, or not known to this set.
-
getAnyTypeInfo
public CBuiltinLeafInfo getAnyTypeInfo()
Description copied from interface:TypeInfoSetGets theTypeInfofor the any type.- Specified by:
getAnyTypeInfoin interfaceTypeInfoSet<NType,NClass,Void,Void>
-
getTypeInfo
public CNonElement getTypeInfo(Ref<NType,NClass> ref)
Description copied from interface:TypeInfoSetReturns a type information for the given reference.- Specified by:
getTypeInfoin interfaceTypeInfoSet<NType,NClass,Void,Void>
-
beans
public Map<NClass,CClassInfo> beans()
Description copied from interface:TypeInfoSetReturns all theClassInfos known to this set.
-
enums
public Map<NClass,CEnumLeafInfo> enums()
Description copied from interface:TypeInfoSetReturns all theEnumLeafInfos known to this set.
-
arrays
public Map<NType,? extends CArrayInfo> arrays()
No array mapping generation for XJC.
-
builtins
public Map<NType,? extends CBuiltinLeafInfo> builtins()
Description copied from interface:TypeInfoSetReturns all theBuiltinLeafInfos known to this set.
-
getClassInfo
public CClassInfo getClassInfo(NClass t)
Description copied from interface:TypeInfoSetReturns aClassInfo,ArrayInfo, orLeafInfofor the given bean.This method is almost like refinement of
TypeInfoSet.getTypeInfo(Object)except our C cannot derive from T.- Specified by:
getClassInfoin interfaceTypeInfoSet<NType,NClass,Void,Void>- Returns:
- null if the specified type is not bound by JAXB or otherwise unknown to this set.
-
getElementInfo
public CElementInfo getElementInfo(NClass scope, QName name)
Description copied from interface:TypeInfoSetReturns aElementInfofor the given element.- Specified by:
getElementInfoin interfaceTypeInfoSet<NType,NClass,Void,Void>- Parameters:
scope- if null, return the info about a global element. Otherwise return a local element in the given scope if available, then look for a global element next.
-
getElementMappings
public Map<QName,CElementInfo> getElementMappings(NClass scope)
Description copied from interface:TypeInfoSetReturns allElementInfos in the given scope.- Specified by:
getElementMappingsin interfaceTypeInfoSet<NType,NClass,Void,Void>- Parameters:
scope- if non-null, this method only returns the local element mapping.
-
getAllElements
public Iterable<? extends CElementInfo> getAllElements()
Description copied from interface:TypeInfoSetReturns all theElementInfoknown to this set.- Specified by:
getAllElementsin interfaceTypeInfoSet<NType,NClass,Void,Void>
-
getSchemaComponent
@Deprecated public XSComponent getSchemaComponent()
Deprecated.Always return null. Perhaps you are interested inschemaComponent?Description copied from interface:CCustomizableIf this model object is built from XML Schema, this property returns a schema component from which the model is built.- Specified by:
getSchemaComponentin interfaceCCustomizable- Returns:
- null if the model is built from sources other than XML Schema (such as DTD.)
-
getLocator
@Deprecated public Locator getLocator()
Deprecated.No line number available for the "root" component.Description copied from interface:CCustomizableGets the source location in the schema from which this model component is created.- Specified by:
getLocatorin interfaceCCustomizable- Returns:
- never null.
-
getCustomizations
public CCustomizations getCustomizations()
Gets the global customizations.- Specified by:
getCustomizationsin interfaceCCustomizable- Returns:
- can be an empty list but never be null. The returned list is read-only. Do not modify.
- See Also:
Plugin.getCustomizationURIs()
-
getXmlNs
public Map<String,String> getXmlNs(String namespaceUri)
Not implemented in the compile-time model.
-
getSchemaLocations
public Map<String,String> getSchemaLocations()
Description copied from interface:TypeInfoSetGetsXmlSchema.location()found in this context.This operation is expected to be only used in schema generator, so it can be slow.
- Specified by:
getSchemaLocationsin interfaceTypeInfoSet<NType,NClass,Void,Void>- Returns:
- A map from namespace URI to the value of the location.
If the entry is missing, that means a schema should be generated for that namespace.
If the value is "", that means the schema location is implied
(
<xs:schema namespace="..."/>w/o schemaLocation.)
-
getElementFormDefault
public jakarta.xml.bind.annotation.XmlNsForm getElementFormDefault(String nsUri)
Description copied from interface:TypeInfoSetGets the reasonableXmlNsFormfor the given namespace URI.The spec doesn't define very precisely what the
XmlNsFormvalue for the given namespace would be, so this method is implemented in rather ad-hoc way. It should work as what most people expect for simple cases.- Specified by:
getElementFormDefaultin interfaceTypeInfoSet<NType,NClass,Void,Void>- Returns:
- never null.
-
getAttributeFormDefault
public jakarta.xml.bind.annotation.XmlNsForm getAttributeFormDefault(String nsUri)
Description copied from interface:TypeInfoSetGets the reasonableXmlNsFormfor the given namespace URI.The spec doesn't define very precisely what the
XmlNsFormvalue for the given namespace would be, so this method is implemented in rather ad-hoc way. It should work as what most people expect for simple cases.- Specified by:
getAttributeFormDefaultin interfaceTypeInfoSet<NType,NClass,Void,Void>- Returns:
- never null.
-
dump
public void dump(Result out)
Description copied from interface:TypeInfoSetDumps this model into XML. For debug only. TODO: not sure if this actually works. We don't really know what are T,C.
-
getPackage
public CClassInfoParent.Package getPackage(JPackage pkg)
-
-