Interface ClassWriter
- All Known Implementing Classes:
ClassWriterImpl
Deprecated.
The interface for writing class 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
addClassContentTree
(Content contentTree, Content classContentTree) Deprecated.Add the class content tree.void
addClassDeprecationInfo
(Content classInfoTree) Deprecated.If this class is deprecated, add the appropriate information.void
addClassDescription
(Content classInfoTree) Deprecated.Build the class description.void
addClassSignature
(String modifiers, Content classInfoTree) Deprecated.Add the signature of the current class content tree.void
addClassTagInfo
(Content classInfoTree) Deprecated.Add the tag information for the current class.void
addClassTree
(Content classContentTree) Deprecated.Add the class tree documentation.void
Deprecated.Add the footer of the page.void
addFunctionalInterfaceInfo
(Content classInfoTree) Deprecated.If this is an functional interface, display appropriate message.void
addImplementedInterfacesInfo
(Content classInfoTree) Deprecated.Add all implemented interfaces if this is a class.void
addInterfaceUsageInfo
(Content classInfoTree) Deprecated.If this is an interface, add all classes that implement this interface.void
addNestedClassInfo
(Content classInfoTree) Deprecated.If this is an inner class or interface, add the enclosing class or interface.void
addSubClassInfo
(Content classInfoTree) Deprecated.Add all the classes that extend this one.void
addSubInterfacesInfo
(Content classInfoTree) Deprecated.Add all the interfaces that extend this one.void
addSuperInterfacesInfo
(Content classInfoTree) Deprecated.Add all super interfaces if this is an interface.void
addTypeParamInfo
(Content classInfoTree) Deprecated.Add the type parameter information.void
close()
Deprecated.Close the writer.Deprecated.Get the class content header.Deprecated.Return the classDoc being documented.getClassInfo
(Content classInfoTree) Deprecated.Get the class information.Deprecated.Get the class information tree header.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.Deprecated.Get the member tree header for the class.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:
- header content that needs to be added to the documentation
-
getClassContentHeader
Content getClassContentHeader()Deprecated.Get the class content header.- Returns:
- class content header that needs to be added to the documentation
-
addClassTree
Deprecated.Add the class tree documentation.- Parameters:
classContentTree
- class content tree to which the documentation will be added
-
getClassInfoTreeHeader
Content getClassInfoTreeHeader()Deprecated.Get the class information tree header.- Returns:
- class informaion tree header that needs to be added to the documentation
-
addTypeParamInfo
Deprecated.Add the type parameter information.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addSuperInterfacesInfo
Deprecated.Add all super interfaces if this is an interface.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addImplementedInterfacesInfo
Deprecated.Add all implemented interfaces if this is a class.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addSubClassInfo
Deprecated.Add all the classes that extend this one.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addSubInterfacesInfo
Deprecated.Add all the interfaces that extend this one.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addInterfaceUsageInfo
Deprecated.If this is an interface, add all classes that implement this interface.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addFunctionalInterfaceInfo
Deprecated.If this is an functional interface, display appropriate message.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addNestedClassInfo
Deprecated.If this is an inner class or interface, add the enclosing class or interface.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
getClassInfo
Deprecated.Get the class information.- Parameters:
classInfoTree
- content tree conatining the class information- Returns:
- a content tree for the class
-
addClassDeprecationInfo
Deprecated.If this class is deprecated, add the appropriate information.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addClassSignature
Deprecated.Add the signature of the current class content tree.- Parameters:
modifiers
- the modifiers for the signatureclassInfoTree
- the class content tree to which the signature will be added
-
addClassDescription
Deprecated.Build the class description.- Parameters:
classInfoTree
- content tree to which the documentation will be added
-
addClassTagInfo
Deprecated.Add the tag information for the current class.- Parameters:
classInfoTree
- content tree to which the tag information will be added
-
getMemberTreeHeader
Content getMemberTreeHeader()Deprecated.Get the member tree header for the class.- Returns:
- a content tree for the member tree header
-
addClassContentTree
Deprecated.Add the class content tree.- Parameters:
contentTree
- content tree to which the class content will be addedclassContentTree
- class content tree which will be added to the content tree
-
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
-
getClassDoc
ClassDoc getClassDoc()Deprecated.Return the classDoc being documented.- Returns:
- the classDoc being documented.
-
getMemberSummaryTree
Deprecated.Get the member summary tree.- Parameters:
memberTree
- the content tree 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 used to build the details tree- Returns:
- a content tree for the member details
-