Class BIEnum
java.lang.Object
com.sun.tools.xjc.reader.xmlschema.bindinfo.BIEnum
- All Implemented Interfaces:
BIDeclaration
Enumeration customization.
This customization binds a simple type to a type-safe enum class.
The actual binding process takes place in SimpleTypeBuilder
.
This customization is acknowledged by SimpleTypeBuilder
.
- Author:
- Kohsuke Kawaguchi ([email protected])
-
Field Summary
FieldsModifier and TypeFieldDescriptionGets the specified class name, or null if not specified.final String
Gets the javadoc comment specified in the customization.final Map<String,
BIEnumMember> Gets the map that containsXML value -> BIEnumMember
pairs.static final QName
Name of this declaration.protected BindInfo
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final BGMBuilder
Gets child s if any.protected final JCodeModel
Gets the source location where this declaration was written.getName()
Gets the name of this binding declaration, which is the same as the tag name of the binding element.protected final XSComponent
getOwner()
final boolean
Checks if this declaration was acknowledged.boolean
isMapped()
void
Marks this declaration to be acknowledged -- either actually used or the existence is admitted (for example when a property customization is given at the point of definition.)void
Called when the parentBindInfo
got its owner set.void
Sets the parent BindInfo object of this declaration.
-
Field Details
-
className
Gets the specified class name, or null if not specified. -
ref
- See Also:
-
javadoc
Gets the javadoc comment specified in the customization. Can be null if none is specified. -
members
Gets the map that containsXML value -> BIEnumMember
pairs. This table is built from<enumMember>
customizations. Always return non-null. -
NAME
Name of this declaration. -
parent
-
-
Constructor Details
-
BIEnum
public BIEnum()Default constructor.
-
-
Method Details
-
isMapped
public boolean isMapped() -
getName
Description copied from interface:BIDeclaration
Gets the name of this binding declaration, which is the same as the tag name of the binding element. -
setParent
Description copied from interface:BIDeclaration
Sets the parent BindInfo object of this declaration. A declaration object can use this pointer to access context information, such as other customizations.This method can be only called from
BindInfo
, and only once. This is a good opportunity to do some follow-up initialization after JAXB unmarshalling populated .- Specified by:
setParent
in interfaceBIDeclaration
-
getLocation
Description copied from interface:BIDeclaration
Gets the source location where this declaration was written. For declarations that are generated by XJC itself, this method returns null.- Specified by:
getLocation
in interfaceBIDeclaration
-
getOwner
-
getBuilder
-
getCodeModel
-
isAcknowledged
public final boolean isAcknowledged()Description copied from interface:BIDeclaration
Checks if this declaration was acknowledged.- Specified by:
isAcknowledged
in interfaceBIDeclaration
-
onSetOwner
public void onSetOwner()Description copied from interface:BIDeclaration
Called when the parentBindInfo
got its owner set. This is when declarations are connected toBGMBuilder
and its sibling components.- Specified by:
onSetOwner
in interfaceBIDeclaration
-
getChildren
Description copied from interface:BIDeclaration
Gets child s if any.- Specified by:
getChildren
in interfaceBIDeclaration
- Returns:
- can be empty but always non-null. read-only.
-
markAsAcknowledged
public void markAsAcknowledged()Description copied from interface:BIDeclaration
Marks this declaration to be acknowledged -- either actually used or the existence is admitted (for example when a property customization is given at the point of definition.)Declarations that are not acknowledged will be considered as an error.
- Specified by:
markAsAcknowledged
in interfaceBIDeclaration
-