API 1.3.0-SNAPSHOT¶
Base Package: com.github.markusbernhardt.xmldoclet
Base¶
Parser¶
extends: Object
The main parser class. It scans the given Doclet document root and creates the XML tree.
Parser ()
parseRootDoc (rootDoc) → Root
The entry point into parsing the javadoc.
RootDoc rootDoc | rootDoc The RootDoc intstance obtained via the doclet API
returns Root | The root node, containing everything parsed from javadoc doclet
PackageDoc packageDocreturns PackageParse an annotation.
AnnotationTypeDoc annotationTypeDoc | annotationTypeDoc A AnnotationTypeDoc instancereturns Annotation | the annotation nodeParse the elements of an annotation
AnnotationTypeElementDoc annotationTypeElementDoc | annotationTypeElementDoc A AnnotationTypeElementDoc instancereturns AnnotationElement | the annotation element nodeParses annotation instances of an annotable program element
AnnotationDesc annotationDesc | annotationDesc annotationDescString programElement | programElement programElementreturns AnnotationInstance | representation of annotationsClassDoc classDocreturns EnumParses an enum type definition
FieldDoc fieldDocreturns EnumConstant |ClassDoc classDocreturns InterfaceClassDoc classDocreturns ClassConstructorDoc constructorDocreturns ConstructorMethodDoc methodDocreturns MethodParameter parameterreturns MethodParameterFieldDoc fieldDocreturns FieldType typereturns TypeInfoWildcardType wildcardreturns WildcardParse type variables for generics
TypeVariable typeVariablereturns TypeParameter |Tag tagDocreturns TagInfoReturns string representation of scope
ProgramElementDoc docreturns String |
XmlDoclet¶
extends: Object
Doclet class.
XmlDoclet ()
optionLength (optionName) → int
Check for doclet-added options. Returns the number of arguments you must specify on the command line for the given option. For example, “-d docs” would return 2.
This method is required if the doclet contains any options. If this method is missing, Javadoc will print an invalid flag error for every option.
String optionName | optionName The name of the option.
returns int | number of arguments on the command line for an option including the option name itself. Zero return means option not known. Negative value means error occurred.
validOptions (optionsArrayArray, reporter) → boolean
Check that options have the correct arguments.
This method is not required, but is recommended, as every option will be considered valid if this method is not present. It will default gracefully (to true) if absent.
Printing option related error messages (using the provided DocErrorReporter) is the responsibility of this method.
String optionsArrayArray | optionsArrayArray The two-dimensional array of options.
DocErrorReporter reporter | reporter The error reporter.
returns boolean |
true
if the options are valid.start (rootDoc) → boolean
Processes the JavaDoc documentation.
This method is required for all doclets.
RootDoc rootDoc | rootDoc The root of the documentation tree.
returns boolean |
true
if processing was successful.transform (xsltInputStream, xmlFile, outFile, parameters)
InputStream xsltInputStream
File xmlFile
File outFile
Map parameters
save (commandLine, root)
Save XML object model to a file via JAXB.
CommandLine commandLine | commandLine the parsed command line arguments
Root root | root the document root
languageVersion () → LanguageVersion
Return the version of the Java Programming Language supported by this doclet.
This method is required by any doclet supporting a language version newer than 1.1.
This Doclet supports Java 5.
returns LanguageVersion | LanguageVersion#JAVA_1_5
parseCommandLine (optionsArrayArray) → CommandLine
Parse the given options.
String optionsArrayArray | optionsArrayArray The two dimensional array of options.
returns CommandLine | the parsed command line arguments.
xjc¶
Annotation¶
extends: Object
Java class for annotation complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”annotation”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”element” type=”{}annotationElement” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> </restriction> </complexContent> </complexType>
Annotation ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getElement () → List
Gets the value of the element property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the element property.For example, to add a new item, do as follows: getElement().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationElement
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
AnnotationArgument¶
extends: Object
Java class for annotationArgument complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”annotationArgument”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”type” type=”{}typeInfo” minOccurs=”0”/> <choice> <element name=”value” type=”{http://www.w3.org/2001/XMLSchema}string” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </choice> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”primitive” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”array” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> </restriction> </complexContent> </complexType>
AnnotationArgument ()
getType () → TypeInfo
Gets the value of the type property.
returns TypeInfo | possible object is TypeInfo
getValue () → List
Gets the value of the value property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the value property.For example, to add a new item, do as follows: getValue().add(newItem);
Objects of the following type(s) are allowed in the list String
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
isPrimitive () → boolean
Gets the value of the primitive property.
returns boolean | possible object is Boolean
setPrimitive (value)
Sets the value of the primitive property.
Boolean value
isArray () → boolean
Gets the value of the array property.
returns boolean | possible object is Boolean
setArray (value)
Sets the value of the array property.
Boolean value
AnnotationElement¶
extends: Object
Java class for annotationElement complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”annotationElement”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”type” type=”{}typeInfo” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”default” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
AnnotationElement ()
getType () → TypeInfo
Gets the value of the type property.
returns TypeInfo | possible object is TypeInfo
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getDefault () → String
Gets the value of the default property.
returns String | possible object is String
setDefault (value)
Sets the value of the default property.
String value
AnnotationInstance¶
extends: Object
Java class for annotationInstance complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”annotationInstance”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”argument” type=”{}annotationArgument” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
AnnotationInstance ()
getArgument () → List
Gets the value of the argument property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the argument property.For example, to add a new item, do as follows: getArgument().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationArgument
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
Class¶
extends: Object
Java class for class complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”class”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”generic” type=”{}typeParameter” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”class” type=”{}typeInfo” minOccurs=”0”/> <element name=”interface” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”constructor” type=”{}constructor” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”method” type=”{}method” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”field” type=”{}field” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”abstract” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”error” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”exception” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”externalizable” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> <attribute name=”serializable” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> </restriction> </complexContent> </complexType>
Class ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getGeneric () → List
Gets the value of the generic property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the generic property.For example, to add a new item, do as follows: getGeneric().add(newItem);
Objects of the following type(s) are allowed in the list TypeParameter
returns List
getClazz () → TypeInfo
Gets the value of the clazz property.
returns TypeInfo | possible object is TypeInfo
getInterface () → List
Gets the value of the interface property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the interface property.For example, to add a new item, do as follows: getInterface().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getConstructor () → List
Gets the value of the constructor property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the constructor property.For example, to add a new item, do as follows: getConstructor().add(newItem);
Objects of the following type(s) are allowed in the list Constructor
returns List
getMethod () → List
Gets the value of the method property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the method property.For example, to add a new item, do as follows: getMethod().add(newItem);
Objects of the following type(s) are allowed in the list Method
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getField () → List
Gets the value of the field property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the field property.For example, to add a new item, do as follows: getField().add(newItem);
Objects of the following type(s) are allowed in the list Field
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isAbstract () → boolean
Gets the value of the abstract property.
returns boolean | possible object is Boolean
setAbstract (value)
Sets the value of the abstract property.
Boolean value
isError () → boolean
Gets the value of the error property.
returns boolean | possible object is Boolean
setError (value)
Sets the value of the error property.
Boolean value
isException () → boolean
Gets the value of the exception property.
returns boolean | possible object is Boolean
setException (value)
Sets the value of the exception property.
Boolean value
isExternalizable () → boolean
Gets the value of the externalizable property.
returns boolean | possible object is Boolean
setExternalizable (value)
Sets the value of the externalizable property.
Boolean value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
isSerializable () → boolean
Gets the value of the serializable property.
returns boolean | possible object is Boolean
setSerializable (value)
Sets the value of the serializable property.
Boolean value
Constructor¶
extends: Object
Java class for constructor complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”constructor”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”parameter” type=”{}methodParameter” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”exception” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”signature” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”final” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> <attribute name=”native” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”synchronized” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”static” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”varArgs” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> </restriction> </complexContent> </complexType>
Constructor ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getParameter () → List
Gets the value of the parameter property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the parameter property.For example, to add a new item, do as follows: getParameter().add(newItem);
Objects of the following type(s) are allowed in the list MethodParameter
returns List
getException () → List
Gets the value of the exception property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the exception property.For example, to add a new item, do as follows: getException().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getSignature () → String
Gets the value of the signature property.
returns String | possible object is String
setSignature (value)
Sets the value of the signature property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isFinal () → boolean
Gets the value of the final property.
returns boolean | possible object is Boolean
setFinal (value)
Sets the value of the final property.
Boolean value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
isNative () → boolean
Gets the value of the native property.
returns boolean | possible object is Boolean
setNative (value)
Sets the value of the native property.
Boolean value
isSynchronized () → boolean
Gets the value of the synchronized property.
returns boolean | possible object is Boolean
setSynchronized (value)
Sets the value of the synchronized property.
Boolean value
isStatic () → boolean
Gets the value of the static property.
returns boolean | possible object is Boolean
setStatic (value)
Sets the value of the static property.
Boolean value
isVarArgs () → boolean
Gets the value of the varArgs property.
returns boolean | possible object is Boolean
setVarArgs (value)
Sets the value of the varArgs property.
Boolean value
Enum¶
extends: Object
Java class for enum complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”enum”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”class” type=”{}typeInfo” minOccurs=”0”/> <element name=”interface” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”constant” type=”{}enumConstant” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> </restriction> </complexContent> </complexType>
Enum ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getClazz () → TypeInfo
Gets the value of the clazz property.
returns TypeInfo | possible object is TypeInfo
getInterface () → List
Gets the value of the interface property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the interface property.For example, to add a new item, do as follows: getInterface().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getConstant () → List
Gets the value of the constant property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the constant property.For example, to add a new item, do as follows: getConstant().add(newItem);
Objects of the following type(s) are allowed in the list EnumConstant
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
EnumConstant¶
extends: Object
Java class for enumConstant complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”enumConstant”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
EnumConstant ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
Field¶
extends: Object
Java class for field complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”field”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”type” type=”{}typeInfo” minOccurs=”0”/> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”constant” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”volatile” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”transient” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”static” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”final” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> </restriction> </complexContent> </complexType>
Field ()
getType () → TypeInfo
Gets the value of the type property.
returns TypeInfo | possible object is TypeInfo
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getConstant () → String
Gets the value of the constant property.
returns String | possible object is String
setConstant (value)
Sets the value of the constant property.
String value
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isVolatile () → boolean
Gets the value of the volatile property.
returns boolean | possible object is Boolean
setVolatile (value)
Sets the value of the volatile property.
Boolean value
isTransient () → boolean
Gets the value of the transient property.
returns boolean | possible object is Boolean
setTransient (value)
Sets the value of the transient property.
Boolean value
isStatic () → boolean
Gets the value of the static property.
returns boolean | possible object is Boolean
setStatic (value)
Sets the value of the static property.
Boolean value
isFinal () → boolean
Gets the value of the final property.
returns boolean | possible object is Boolean
setFinal (value)
Sets the value of the final property.
Boolean value
Interface¶
extends: Object
Java class for interface complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”interface”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”generic” type=”{}typeParameter” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”interface” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”method” type=”{}method” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”field” type=”{}field” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> </restriction> </complexContent> </complexType>
Interface ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getGeneric () → List
Gets the value of the generic property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the generic property.For example, to add a new item, do as follows: getGeneric().add(newItem);
Objects of the following type(s) are allowed in the list TypeParameter
returns List
getInterface () → List
Gets the value of the interface property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the interface property.For example, to add a new item, do as follows: getInterface().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getMethod () → List
Gets the value of the method property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the method property.For example, to add a new item, do as follows: getMethod().add(newItem);
Objects of the following type(s) are allowed in the list Method
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getField () → List
Gets the value of the field property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the field property.For example, to add a new item, do as follows: getField().add(newItem);
Objects of the following type(s) are allowed in the list Field
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
Method¶
extends: Object
Java class for method complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”method”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”parameter” type=”{}methodParameter” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”return” type=”{}typeInfo” minOccurs=”0”/> <element name=”exception” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”signature” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”scope” type=”{}scope” /> <attribute name=”abstract” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”final” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”included” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”true” /> <attribute name=”native” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”synchronized” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”static” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> <attribute name=”varArgs” type=”{http://www.w3.org/2001/XMLSchema}boolean” default=”false” /> </restriction> </complexContent> </complexType>
Method ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getParameter () → List
Gets the value of the parameter property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the parameter property.For example, to add a new item, do as follows: getParameter().add(newItem);
Objects of the following type(s) are allowed in the list MethodParameter
returns List
getReturn () → TypeInfo
Gets the value of the return property.
returns TypeInfo | possible object is TypeInfo
getException () → List
Gets the value of the exception property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the exception property.For example, to add a new item, do as follows: getException().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getSignature () → String
Gets the value of the signature property.
returns String | possible object is String
setSignature (value)
Sets the value of the signature property.
String value
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getScope () → String
Gets the value of the scope property.
returns String | possible object is String
setScope (value)
Sets the value of the scope property.
String value
isAbstract () → boolean
Gets the value of the abstract property.
returns boolean | possible object is Boolean
setAbstract (value)
Sets the value of the abstract property.
Boolean value
isFinal () → boolean
Gets the value of the final property.
returns boolean | possible object is Boolean
setFinal (value)
Sets the value of the final property.
Boolean value
isIncluded () → boolean
Gets the value of the included property.
returns boolean | possible object is Boolean
setIncluded (value)
Sets the value of the included property.
Boolean value
isNative () → boolean
Gets the value of the native property.
returns boolean | possible object is Boolean
setNative (value)
Sets the value of the native property.
Boolean value
isSynchronized () → boolean
Gets the value of the synchronized property.
returns boolean | possible object is Boolean
setSynchronized (value)
Sets the value of the synchronized property.
Boolean value
isStatic () → boolean
Gets the value of the static property.
returns boolean | possible object is Boolean
setStatic (value)
Sets the value of the static property.
Boolean value
isVarArgs () → boolean
Gets the value of the varArgs property.
returns boolean | possible object is Boolean
setVarArgs (value)
Sets the value of the varArgs property.
Boolean value
MethodParameter¶
extends: Object
Java class for methodParameter complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”methodParameter”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”type” type=”{}typeInfo” minOccurs=”0”/> <element name=”annotation” type=”{}annotationInstance” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
MethodParameter ()
getType () → TypeInfo
Gets the value of the type property.
returns TypeInfo | possible object is TypeInfo
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list AnnotationInstance
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
ObjectFactory¶
extends: Object
This object contains factory methods for each Java content interface and Java element interface generated in the com.github.markusbernhardt.xmldoclet.xjc package.
An ObjectFactory allows you to programatically construct new instances of the Java representation for XML content. The Java representation of XML content can consist of schema derived interfaces and classes representing the binding of schema type definitions, element declarations and model groups. Factory methods for each of these are provided in this class.
ObjectFactory ()
Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: com.github.markusbernhardt.xmldoclet.xjc
createAnnotationElement () → AnnotationElement
Create an instance of AnnotationElement
returns AnnotationElement
createAnnotationInstance () → AnnotationInstance
Create an instance of AnnotationInstance
returns AnnotationInstance
createAnnotationArgument () → AnnotationArgument
Create an instance of AnnotationArgument
returns AnnotationArgument
createMethodParameter () → MethodParameter
Create an instance of MethodParameter
returns MethodParameter
Package¶
extends: Object
Java class for package complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”package”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”comment” type=”{http://www.w3.org/2001/XMLSchema}string” minOccurs=”0”/> <element name=”tag” type=”{}tagInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”annotation” type=”{}annotation” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”enum” type=”{}enum” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”interface” type=”{}interface” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”class” type=”{}class” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
Package ()
getComment () → String
Gets the value of the comment property.
returns String | possible object is String
setComment (value)
Sets the value of the comment property.
String value
getTag () → List
Gets the value of the tag property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the tag property.For example, to add a new item, do as follows: getTag().add(newItem);
Objects of the following type(s) are allowed in the list TagInfo
returns List
getAnnotation () → List
Gets the value of the annotation property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the annotation property.For example, to add a new item, do as follows: getAnnotation().add(newItem);
Objects of the following type(s) are allowed in the list Annotation
returns List
getEnum () → List
Gets the value of the enum property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the enum property.For example, to add a new item, do as follows: getEnum().add(newItem);
Objects of the following type(s) are allowed in the list Enum
returns List
getInterface () → List
Gets the value of the interface property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the interface property.For example, to add a new item, do as follows: getInterface().add(newItem);
Objects of the following type(s) are allowed in the list Interface
returns List
getClazz () → List
Gets the value of the clazz property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the clazz property.For example, to add a new item, do as follows: getClazz().add(newItem);
Objects of the following type(s) are allowed in the list Class
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
Root¶
extends: Object
Java class for anonymous complex type.
The following schema fragment specifies the expected content contained within this class. <complexType> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”package” type=”{}package” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> </restriction> </complexContent> </complexType>
Root ()
getPackage () → List
Gets the value of the package property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the package property.For example, to add a new item, do as follows: getPackage().add(newItem);
Objects of the following type(s) are allowed in the list Package
returns List
TagInfo¶
extends: Object
Java class for tagInfo complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”tagInfo”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”text” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
TagInfo ()
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
getText () → String
Gets the value of the text property.
returns String | possible object is String
setText (value)
Sets the value of the text property.
String value
TypeInfo¶
extends: Object
Java class for typeInfo complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”typeInfo”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”wildcard” type=”{}wildcard” minOccurs=”0”/> <element name=”generic” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”qualified” type=”{http://www.w3.org/2001/XMLSchema}string” /> <attribute name=”dimension” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
TypeInfo ()
getWildcard () → Wildcard
Gets the value of the wildcard property.
returns Wildcard | possible object is Wildcard
getGeneric () → List
Gets the value of the generic property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the generic property.For example, to add a new item, do as follows: getGeneric().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getQualified () → String
Gets the value of the qualified property.
returns String | possible object is String
setQualified (value)
Sets the value of the qualified property.
String value
getDimension () → String
Gets the value of the dimension property.
returns String | possible object is String
setDimension (value)
Sets the value of the dimension property.
String value
TypeParameter¶
extends: Object
Java class for typeParameter complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”typeParameter”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”bound” type=”{http://www.w3.org/2001/XMLSchema}string” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> <attribute name=”name” type=”{http://www.w3.org/2001/XMLSchema}string” /> </restriction> </complexContent> </complexType>
TypeParameter ()
getBound () → List
Gets the value of the bound property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the bound property.For example, to add a new item, do as follows: getBound().add(newItem);
Objects of the following type(s) are allowed in the list String
returns List
getName () → String
Gets the value of the name property.
returns String | possible object is String
setName (value)
Sets the value of the name property.
String value
Wildcard¶
extends: Object
Java class for wildcard complex type.
The following schema fragment specifies the expected content contained within this class. <complexType name=”wildcard”> <complexContent> <restriction base=”{http://www.w3.org/2001/XMLSchema}anyType”> <sequence> <element name=”extendsBound” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> <element name=”superBound” type=”{}typeInfo” maxOccurs=”unbounded” minOccurs=”0”/> </sequence> </restriction> </complexContent> </complexType>
Wildcard ()
getExtendsBound () → List
Gets the value of the extendsBound property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the extendsBound property.For example, to add a new item, do as follows: getExtendsBound().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List
getSuperBound () → List
Gets the value of the superBound property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
set
method for the superBound property.For example, to add a new item, do as follows: getSuperBound().add(newItem);
Objects of the following type(s) are allowed in the list TypeInfo
returns List