Class CEnumLeafInfo
- All Implemented Interfaces:
CCustomizable
,CNonElement
,CTypeInfo
,NClass
,NType
,TypeUse
,Locatable
,EnumLeafInfo<NType,
,NClass> LeafInfo<NType,
,NClass> MaybeElement<NType,
,NClass> NonElement<NType,
,NClass> TypeInfo<NType,
NClass>
- Author:
- Kohsuke KAWAGUCHI
-
Field Summary
Modifier and TypeFieldDescriptionfinal CNonElement
Represents the underlying type of this enumeration and its conversion.final Collection<CEnumConstant>
List of enum members.final Model
TheModel
object to which this bean belongs.final CClassInfoParent
The parent into which the enum class should be generated.final String
Short name of the generated type-safe enum.Fields inherited from interface org.glassfish.jaxb.core.v2.model.core.NonElement
ANYTYPE_NAME
-
Constructor Summary
ConstructorDescriptionCEnumLeafInfo
(Model model, QName typeName, CClassInfoParent container, String shortName, CNonElement base, Collection<CEnumConstant> _members, XSComponent source, CCustomizations customizations, Locator _sourceLocator) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Deprecated.why are you calling the method whose return value is known?createConstant
(Outline outline, XmlString literal) Creates a constant for the given lexical value.fullName()
Human readable name of this type.Deprecated.getClazz()
Gets the list of customizations attached to this model component.A can have an associated MIME type.getInfo()
Deprecated.Source line information that points to the place where this type-safe enum is defined.If this model object is built from XML Schema, this property returns a schema component from which the model is built.getType()
idUse()
Whether the referenced type (individual item type in case of collection) is ID/IDREF.boolean
boolean
Returns true iff this type represents a class that has a unboxed form.boolean
Deprecated.boolean
boolean
boolean
boolean
The spec says the value field in the enum class will be generated only under certain circumstances.Returns the representation of this type in code model.
-
Field Details
-
model
TheModel
object to which this bean belongs. -
parent
The parent into which the enum class should be generated. -
shortName
Short name of the generated type-safe enum. -
base
Represents the underlying type of this enumeration and its conversion.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.
-
members
List of enum members. -
javadoc
-
-
Constructor Details
-
CEnumLeafInfo
public CEnumLeafInfo(Model model, QName typeName, CClassInfoParent container, String shortName, CNonElement base, Collection<CEnumConstant> _members, XSComponent source, CCustomizations customizations, Locator _sourceLocator)
-
-
Method Details
-
getLocator
Source line information that points to the place where this type-safe enum is defined. Used to report error messages.- Specified by:
getLocator
in interfaceCCustomizable
- Returns:
- never null.
-
getTypeName
- Specified by:
getTypeName
in interfaceNonElement<NType,
NClass>
-
getType
-
canBeReferencedByIDREF
Deprecated.why are you calling the method whose return value is known?- Specified by:
canBeReferencedByIDREF
in interfaceTypeInfo<NType,
NClass>
-
isElement
public boolean isElement()- Specified by:
isElement
in interfaceMaybeElement<NType,
NClass>
-
getElementName
- Specified by:
getElementName
in interfaceMaybeElement<NType,
NClass>
-
asElement
- Specified by:
asElement
in interfaceMaybeElement<NType,
NClass>
-
getClazz
- Specified by:
getClazz
in interfaceEnumLeafInfo<NType,
NClass>
-
getSchemaComponent
Description copied from interface:CCustomizable
If this model object is built from XML Schema, this property returns a schema component from which the model is built.- Specified by:
getSchemaComponent
in interfaceCCustomizable
- Returns:
- null if the model is built from sources other than XML Schema (such as DTD.)
-
toType
Description copied from interface:NType
Returns the representation of this type in code model.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.
- Specified by:
toType
in interfaceCTypeInfo
- Specified by:
toType
in interfaceNClass
- Specified by:
toType
in interfaceNType
aspect
- IfAspect.IMPLEMENTATION
, this method returns the implementation specific class that this type represents. IfAspect.EXPOSED
, this method returns the publicly exposed type that this type represents. For ordinary classes, the aspect parameter is meaningless.- See Also:
-
isAbstract
public boolean isAbstract()- Specified by:
isAbstract
in interfaceNClass
-
isBoxedType
public boolean isBoxedType()Description copied from interface:NType
Returns true iff this type represents a class that has a unboxed form. For example, forString
this is false, but forInteger
this is true.- Specified by:
isBoxedType
in interfaceNType
-
fullName
Description copied from interface:NType
Human readable name of this type. -
isPrimitive
public boolean isPrimitive() -
isSimpleType
public boolean isSimpleType()- Specified by:
isSimpleType
in interfaceNonElement<NType,
NClass>
-
needsValueField
public boolean needsValueField()The spec says the value field in the enum class will be generated only under certain circumstances.- Returns:
- true if the generated enum class should have the value field.
-
createConstant
Description copied from interface:TypeUse
Creates a constant for the given lexical value.For 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.
- Specified by:
createConstant
in interfaceTypeUse
- Returns:
- null if the constant cannot be created for this (such as when it's a collection)
-
isCollection
Deprecated.Description copied from interface:CNonElement
Guaranteed to return false.- Specified by:
isCollection
in interfaceCNonElement
- Specified by:
isCollection
in interfaceTypeUse
-
getAdapterUse
Deprecated.Description copied from interface:CNonElement
Guaranteed to return null.- Specified by:
getAdapterUse
in interfaceCNonElement
- Specified by:
getAdapterUse
in interfaceTypeUse
-
getInfo
Deprecated.Description copied from interface:CNonElement
Guaranteed to return this.- Specified by:
getInfo
in interfaceCNonElement
- Specified by:
getInfo
in interfaceTypeUse
-
idUse
Description copied from interface:TypeUse
Whether the referenced type (individual item type in case of collection) is ID/IDREF.ID 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 .
-
getExpectedMimeType
Description copied from interface:TypeUse
A can have an associated MIME type.- Specified by:
getExpectedMimeType
in interfaceTypeUse
-
getConstants
- Specified by:
getConstants
in interfaceEnumLeafInfo<NType,
NClass>
-
getBaseType
- Specified by:
getBaseType
in interfaceEnumLeafInfo<NType,
NClass>
-
getCustomizations
Description copied from interface:CCustomizable
Gets the list of customizations attached to this model component.- Specified by:
getCustomizations
in interfaceCCustomizable
- Returns:
- can be an empty list but never be null. The returned list is read-only. Do not modify.
- See Also:
-
getUpstream
- Specified by:
getUpstream
in interfaceLocatable
-
getLocation
- Specified by:
getLocation
in interfaceLocatable
-