|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.XmlSubTask
public class XmlSubTask
Generic subtask for processing a user-supplied template, to generate an XML document.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask |
---|
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType |
Field Summary |
---|
Fields inherited from class xdoclet.DocletSupport |
---|
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
---|---|
XmlSubTask()
|
Method Summary | |
---|---|
void |
copyAttributesFrom(TemplateSubTask templateSrc)
Describe what the method does |
protected void |
engineFinished()
Describe what the method does |
java.net.URL |
getDtdURL()
Gets the DtdURL attribute of the XmlSubTask object. |
java.lang.String |
getPublicId()
Gets the PublicId attribute of the XmlSubTask object. |
java.lang.String |
getSchema()
Gets the Schema attribute of the XmlSubTask object. |
java.net.URL |
getSchemaURL()
Gets the SchemaURL attribute of the XmlSubTask object. |
java.lang.String |
getSystemId()
Gets the SystemId attribute of the XmlSubTask object. |
boolean |
getUseIds()
Gets the UseIds attribute of the XmlSubTask object. |
java.lang.String |
getXmlencoding()
Gets the Xmlencoding attribute of the XmlSubTask object. |
boolean |
isValidateXML()
Gets the ValidateXML attribute of the XmlSubTask object. |
protected void |
setDtdURL(java.net.URL dtdURL)
Sets the DtdURL attribute of the XmlSubTask object. |
protected void |
setPublicId(java.lang.String publicId)
The PUBLIC ID of the DTD to which the generated document should conform. |
void |
setSchema(java.lang.String schema)
The XML Schema to which the generated document should conform. |
protected void |
setSchemaURL(java.net.URL url)
Sets the SchemaURL attribute of the XmlSubTask object. |
protected void |
setSystemId(java.lang.String systemId)
The SYSTEM ID of the DTD to which the generated document should conform. |
void |
setUseIds(boolean useIds)
If this attribute is set to true, XDoclet will generate id attributes in the XML document. |
void |
setValidateXML(boolean flag)
If this is set to true, the generated XML will be validated against its DTD or XML Schema. |
void |
setXmlencoding(java.lang.String xmlEncoding)
The encoding of the produced xml file. |
void |
startProcess()
Describe what the method does |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlSubTask()
Method Detail |
---|
public boolean getUseIds()
public java.lang.String getXmlencoding()
public java.net.URL getDtdURL()
public java.lang.String getPublicId()
public java.lang.String getSystemId()
public java.lang.String getSchema()
public boolean isValidateXML()
public java.net.URL getSchemaURL()
public void setUseIds(boolean useIds)
useIds
- The new UseIds valuepublic void setXmlencoding(java.lang.String xmlEncoding)
xmlEncoding
- The new Xmlencoding valuepublic void setSchema(java.lang.String schema)
schema
- The new Schema valuepublic void setValidateXML(boolean flag)
flag
- The new Validatexml valuepublic void copyAttributesFrom(TemplateSubTask templateSrc)
copyAttributesFrom
in class TemplateSubTask
templateSrc
- Describe what the parameter doespublic void startProcess() throws XDocletException
startProcess
in class TemplateSubTask
XDocletException
- Describe the exceptionprotected void setSchemaURL(java.net.URL url)
url
- The new SchemaURL valueprotected void setDtdURL(java.net.URL dtdURL)
dtdURL
- The new DtdURL valueprotected void setPublicId(java.lang.String publicId)
publicId
- The new PublicId valueprotected void setSystemId(java.lang.String systemId)
systemId
- The new SystemId valueprotected void engineFinished() throws XDocletException
engineFinished
in class TemplateSubTask
XDocletException
- Describe the exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |