|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.tools.xjc.model.CEnumLeafInfo
public final class CEnumLeafInfo
Transducer that converts a string into an "enumeration class." The structure of the generated class needs to precisely follow the JAXB spec.
| Field Summary | |
|---|---|
CNonElement |
base
Represents the underlying type of this enumeration and its conversion. |
String |
javadoc
|
Collection<CEnumConstant> |
members
List of enum members. |
Model |
model
The Model object to which this bean belongs. |
CClassInfoParent |
parent
The parent into which the enum class should be generated. |
String |
shortName
Short name of the generated type-safe enum. |
| Fields inherited from interface com.sun.xml.bind.v2.model.core.NonElement |
|---|
ANYTYPE_NAME |
| Constructor Summary | |
|---|---|
CEnumLeafInfo(Model model,
QName typeName,
CClassInfoParent container,
String shortName,
CNonElement base,
Collection<CEnumConstant> _members,
XSComponent source,
CCustomizations customizations,
Locator _sourceLocator)
|
|
| Method Summary | |
|---|---|
Element<NType,NClass> |
asElement()
|
boolean |
canBeReferencedByIDREF()
Deprecated. why are you calling the method whose return value is known? |
JExpression |
createConstant(Outline outline,
XmlString literal)
Creates a constant for the given lexical value. |
String |
fullName()
Human readable name of this type. |
CAdapter |
getAdapterUse()
Deprecated. |
NonElement<NType,NClass> |
getBaseType()
|
NClass |
getClazz()
|
Collection<CEnumConstant> |
getConstants()
|
CCustomizations |
getCustomizations()
Gets the list of customizations attached to this model component. |
QName |
getElementName()
|
MimeType |
getExpectedMimeType()
A TypeUse can have an associated MIME type. |
CNonElement |
getInfo()
Deprecated. |
Location |
getLocation()
|
Locator |
getLocator()
Source line information that points to the place where this type-safe enum is defined. |
XSComponent |
getSchemaComponent()
If this model object is built from XML Schema, this property returns a schema component from which the model is built. |
NType |
getType()
|
QName |
getTypeName()
|
Locatable |
getUpstream()
|
ID |
idUse()
Whether the referenced type (individual item type in case of collection) is ID/IDREF. |
boolean |
isAbstract()
|
boolean |
isBoxedType()
Returns true iff this type represents a class that has a unboxed form. |
boolean |
isCollection()
Deprecated. |
boolean |
isElement()
|
boolean |
isPrimitive()
|
boolean |
isSimpleType()
|
boolean |
needsValueField()
The spec says the value field in the enum class will be generated only under certain circumstances. |
JClass |
toType(Outline o,
Aspect aspect)
Returns the representation of this type in code model. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public final Model model
Model object to which this bean belongs.
public final CClassInfoParent parent
public final String shortName
public final CNonElement base
To parse XML into a constant, we use the base type to do lexical -> value, then use a map to pick up the right one.
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 Collection<CEnumConstant> members
public String javadoc
| Constructor Detail |
|---|
public CEnumLeafInfo(Model model,
QName typeName,
CClassInfoParent container,
String shortName,
CNonElement base,
Collection<CEnumConstant> _members,
XSComponent source,
CCustomizations customizations,
Locator _sourceLocator)
| Method Detail |
|---|
public Locator getLocator()
getLocator in interface CCustomizablepublic QName getTypeName()
getTypeName in interface NonElement<NType,NClass>public NType getType()
getType in interface TypeInfo<NType,NClass>public boolean canBeReferencedByIDREF()
canBeReferencedByIDREF in interface TypeInfo<NType,NClass>public boolean isElement()
isElement in interface MaybeElement<NType,NClass>public QName getElementName()
getElementName in interface MaybeElement<NType,NClass>public Element<NType,NClass> asElement()
asElement in interface MaybeElement<NType,NClass>public NClass getClazz()
getClazz in interface EnumLeafInfo<NType,NClass>public XSComponent getSchemaComponent()
CCustomizable
getSchemaComponent in interface CCustomizable
public JClass toType(Outline o,
Aspect aspect)
NType
This operation requires the whole model to be built,
and hence it takes Outline.
Under some code generation strategy, some bean classes are considered implementation specific (such as impl.FooImpl class) These classes always have accompanying "exposed" type (such as the Foo interface).
For such Jekyll and Hyde type, the aspect parameter determines which personality is returned.
toType in interface CTypeInfotoType in interface NClasstoType in interface NTypeaspect - If Aspect.IMPLEMENTATION, this method returns the
implementation specific class that this type represents.
If Aspect.EXPOSED, this method returns the
publicly exposed type that this type represents.
For ordinary classes, the aspect parameter is meaningless.NType.toType(Outline, Aspect)public boolean isAbstract()
isAbstract in interface NClasspublic boolean isBoxedType()
NTypeString this is false, but for Integer
this is true.
isBoxedType in interface NTypepublic String fullName()
NType
fullName in interface NTypepublic boolean isPrimitive()
public boolean isSimpleType()
isSimpleType in interface NonElement<NType,NClass>public boolean needsValueField()
public JExpression createConstant(Outline outline,
XmlString literal)
TypeUseFor example, to create a constant 1 for xs:int, you'd do:
CBuiltinLeafInfo.INT.createConstant( codeModel, "1", null );
This method is invoked at the backend as a part of the code generation process.
createConstant in interface TypeUseTypeUse
(such as when it's a collection)@Deprecated public boolean isCollection()
CNonElement
isCollection in interface CNonElementisCollection in interface TypeUse@Deprecated public CAdapter getAdapterUse()
CNonElement
getAdapterUse in interface CNonElementgetAdapterUse in interface TypeUse@Deprecated public CNonElement getInfo()
CNonElement
getInfo in interface CNonElementgetInfo in interface TypeUsepublic ID idUse()
TypeUseID is a property of a relationship. When a bean Foo has an ID property called 'bar' whose type is String, Foo isn't an ID, String isn't an ID, but this relationship is an ID (in the sense that Foo uses this String as an ID.)
The same thing can be said with IDREF. When Foo refers to Bar by means of IDREF, neither Foo nor Bar is IDREF.
That's why we have this method in TypeUse.
idUse in interface TypeUsepublic MimeType getExpectedMimeType()
TypeUseTypeUse can have an associated MIME type.
getExpectedMimeType in interface TypeUsepublic Collection<CEnumConstant> getConstants()
getConstants in interface EnumLeafInfo<NType,NClass>public NonElement<NType,NClass> getBaseType()
getBaseType in interface EnumLeafInfo<NType,NClass>public CCustomizations getCustomizations()
CCustomizable
getCustomizations in interface CCustomizablePlugin.getCustomizationURIs()public Locatable getUpstream()
getUpstream in interface Locatablepublic Location getLocation()
getLocation in interface Locatable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||