public class ExtensionDescription extends ExtensionPoint implements java.lang.Comparable<ExtensionDescription>
ExtensionProfile
to indicate that the extension is expected within a particular
ExtensionPoint
.Modifier and Type | Class and Description |
---|---|
static interface |
ExtensionDescription.Default
The Default interface defines a simple annotation model for describing
the default
ExtensionDescription of an Extension class. |
class |
ExtensionDescription.Handler
Reads the ExtensionDescription XML format
|
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
AbstractExtension.AttributesHandler
xmlBlob
Constructor and Description |
---|
ExtensionDescription()
Constructs an uninitialized ExtensionDescription.
|
ExtensionDescription(java.lang.Class<? extends Extension> extensionClass,
XmlNamespace namespace,
java.lang.String localName)
Constructs a new ExtensionDescription for an optional, non-repeating
simple element.
|
ExtensionDescription(java.lang.Class<? extends Extension> extensionClass,
XmlNamespace namespace,
java.lang.String localName,
boolean required,
boolean repeatable,
boolean aggregate)
Constructs a new ExtensionDescription populated with the parameter
values.
|
ExtensionDescription(java.lang.Class<? extends Extension> extensionClass,
XmlNamespace namespace,
java.lang.String localName,
boolean required,
boolean repeatable,
boolean aggregate,
boolean arbitraryXml,
boolean mixedContent)
Constructs a new ExtensionDescription populated with the parameter
values.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowsArbitraryXml() |
boolean |
allowsMixedContent() |
int |
compareTo(ExtensionDescription desc)
Defines a natural ordering for ExtensionDescription based upon
the qualified name of the mapped XML element.
|
void |
generateConfig(XmlWriter w,
ExtensionProfile extProfile)
Generates XML in the external config format.
|
static ExtensionDescription |
getDefaultDescription(java.lang.Class<? extends Extension> extensionClass)
Returns the default
ExtensionDescription for the specified
Extension class. |
java.lang.Class<? extends Extension> |
getExtensionClass() |
java.lang.String |
getLocalName() |
XmlNamespace |
getNamespace() |
boolean |
isAggregate() |
boolean |
isRepeatable() |
boolean |
isRequired() |
void |
setAggregate(boolean aggregate) |
void |
setArbitraryXml(boolean arbitraryXml) |
void |
setExtensionClass(java.lang.Class<? extends Extension> extensionClass) |
void |
setLocalName(java.lang.String localName) |
void |
setMixedContent(boolean mixedContent) |
void |
setNamespace(XmlNamespace namespace) |
void |
setRepeatable(boolean repeatable) |
void |
setRequired(boolean required) |
addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren
consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate
public ExtensionDescription()
public ExtensionDescription(java.lang.Class<? extends Extension> extensionClass, XmlNamespace namespace, java.lang.String localName, boolean required, boolean repeatable, boolean aggregate)
public ExtensionDescription(java.lang.Class<? extends Extension> extensionClass, XmlNamespace namespace, java.lang.String localName, boolean required, boolean repeatable, boolean aggregate, boolean arbitraryXml, boolean mixedContent)
public ExtensionDescription(java.lang.Class<? extends Extension> extensionClass, XmlNamespace namespace, java.lang.String localName)
public static ExtensionDescription getDefaultDescription(java.lang.Class<? extends Extension> extensionClass)
ExtensionDescription
for the specified
Extension class.extensionClass
- the target extension class.java.lang.IllegalArgumentException
- if a default description could not be
fourn for the extension class.public void setNamespace(XmlNamespace namespace)
public final XmlNamespace getNamespace()
public void setLocalName(java.lang.String localName)
public final java.lang.String getLocalName()
public void setExtensionClass(java.lang.Class<? extends Extension> extensionClass)
public final java.lang.Class<? extends Extension> getExtensionClass()
public void setRequired(boolean required)
public final boolean isRequired()
public void setRepeatable(boolean repeatable)
public final boolean isRepeatable()
public void setAggregate(boolean aggregate)
public final boolean isAggregate()
public void setArbitraryXml(boolean arbitraryXml)
public final boolean allowsArbitraryXml()
public void setMixedContent(boolean mixedContent)
public final boolean allowsMixedContent()
public int compareTo(ExtensionDescription desc)
compareTo
in interface java.lang.Comparable<ExtensionDescription>
public void generateConfig(XmlWriter w, ExtensionProfile extProfile) throws java.io.IOException
w
- Output writer.extProfile
- Extension profile.java.io.IOException