Interface AnnotationTypeWriter
- All Known Implementing Classes:
AnnotationTypeWriterImpl
Deprecated.
The interface for writing annotation type output.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAnnotationContentTree
(Content contentTree, Content annotationContentTree) Deprecated.Add the annotation content tree to the documentation content tree.void
addAnnotationTypeDeprecationInfo
(Content annotationInfoTree) Deprecated.If this annotation is deprecated, add the appropriate information.void
addAnnotationTypeDescription
(Content annotationInfoTree) Deprecated.Build the annotation type description.void
addAnnotationTypeSignature
(String modifiers, Content annotationInfoTree) Deprecated.Add the signature of the current annotation type.void
addAnnotationTypeTagInfo
(Content annotationInfoTree) Deprecated.Add the tag information for the current annotation type.void
Deprecated.Add the footer of the page.void
close()
Deprecated.Close the writer.Deprecated.Get the annotation content header.getAnnotationInfo
(Content annotationInfoTree) Deprecated.Get the annotation information.Deprecated.Get the annotation information tree header.Deprecated.Return theAnnotationTypeDoc
being documented.Deprecated.Get the header of the page.getMemberDetailsTree
(Content memberTree) Deprecated.Get the member details tree.getMemberSummaryTree
(Content memberTree) Deprecated.Get the member summary tree.getMemberTree
(Content memberTree) Deprecated.Get the member tree.Deprecated.Get the member tree header for the annotation type.void
printDocument
(Content contentTree) Deprecated.Print the document.
-
Method Details
-
getHeader
Deprecated.Get the header of the page.- Parameters:
header
- the header string to write- Returns:
- a content tree for the header documentation
-
getAnnotationContentHeader
Content getAnnotationContentHeader()Deprecated.Get the annotation content header.- Returns:
- annotation content header that needs to be added to the documentation
-
getAnnotationInfoTreeHeader
Content getAnnotationInfoTreeHeader()Deprecated.Get the annotation information tree header.- Returns:
- annotation information tree header that needs to be added to the documentation
-
getAnnotationInfo
Deprecated.Get the annotation information.- Parameters:
annotationInfoTree
- content tree containing the annotation information- Returns:
- a content tree for the annotation
-
addAnnotationTypeSignature
Deprecated.Add the signature of the current annotation type.- Parameters:
modifiers
- the modifiers for the signatureannotationInfoTree
- the annotation content tree to which the signature will be added
-
addAnnotationTypeDescription
Deprecated.Build the annotation type description.- Parameters:
annotationInfoTree
- content tree to which the description will be added
-
addAnnotationTypeTagInfo
Deprecated.Add the tag information for the current annotation type.- Parameters:
annotationInfoTree
- content tree to which the tag information will be added
-
addAnnotationTypeDeprecationInfo
Deprecated.If this annotation is deprecated, add the appropriate information.- Parameters:
annotationInfoTree
- content tree to which the deprecated information will be added
-
getMemberTreeHeader
Content getMemberTreeHeader()Deprecated.Get the member tree header for the annotation type.- Returns:
- a content tree for the member tree header
-
addAnnotationContentTree
Deprecated.Add the annotation content tree to the documentation content tree.- Parameters:
contentTree
- content tree to which the annotation content will be addedannotationContentTree
- annotation content tree which will be added to the content tree
-
getMemberTree
Deprecated.Get the member tree.- Parameters:
memberTree
- the content tree that will be modified and returned- Returns:
- a content tree for the member
-
getMemberSummaryTree
Deprecated.Get the member summary tree.- Parameters:
memberTree
- the content tree that will be used to build the summary tree- Returns:
- a content tree for the member summary
-
getMemberDetailsTree
Deprecated.Get the member details tree.- Parameters:
memberTree
- the content tree that will be used to build the details tree- Returns:
- a content tree for the member details
-
printDocument
Deprecated.Print the document.- Parameters:
contentTree
- content tree that will be printed as a document- Throws:
IOException
-
close
Deprecated.Close the writer.- Throws:
IOException
-
getAnnotationTypeDoc
AnnotationTypeDoc getAnnotationTypeDoc()Deprecated.Return theAnnotationTypeDoc
being documented.- Returns:
- the AnnotationTypeDoc being documented.
-