Class ClassBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder
Deprecated.
Builds the summary for a given class.
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
-
Nested Class Summary
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ClassDoc
Deprecated.The class being documented.private Content
Deprecated.The content tree for the class documentation.private final boolean
Deprecated.Keep track of whether or not this classdoc is an enum.private final boolean
Deprecated.Keep track of whether or not this classdoc is an interface.static final String
Deprecated.The root element of the class XML is "ClassDoc".private final ClassWriter
Deprecated.The doclet specific writer.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ClassBuilder
(AbstractBuilder.Context context, ClassDoc classDoc, ClassWriter writer) Deprecated.Construct a new ClassBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
Deprecated.Build the documentation.void
buildClassDescription
(XMLNode node, Content classInfoTree) Deprecated.Build the class description.void
buildClassDoc
(XMLNode node, Content contentTree) Deprecated.Handles the <ClassDoc> tag.void
buildClassInfo
(XMLNode node, Content classContentTree) Deprecated.Build the class information tree documentation.void
buildClassSignature
(XMLNode node, Content classInfoTree) Deprecated.Build the signature of the current class.void
buildClassTagInfo
(XMLNode node, Content classInfoTree) Deprecated.Build the tag information for the current class.void
buildClassTree
(XMLNode node, Content classContentTree) Deprecated.Build the class tree documentation.void
buildConstructorDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the constructor documentation.void
buildDeprecationInfo
(XMLNode node, Content classInfoTree) Deprecated.If this class is deprecated, build the appropriate information.void
buildEnumConstantsDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the enum constants documentation.void
buildFieldDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the field documentation.void
buildFunctionalInterfaceInfo
(XMLNode node, Content classInfoTree) Deprecated.If this is an functional interface, display appropriate message.void
buildImplementedInterfacesInfo
(XMLNode node, Content classInfoTree) Deprecated.If this is a class, list all interfaces implemented by this class.void
buildInterfaceUsageInfo
(XMLNode node, Content classInfoTree) Deprecated.If this is an interface, list all classes that implement this interface.void
buildMemberDetails
(XMLNode node, Content classContentTree) Deprecated.Build the member details contents of the page.void
buildMemberSummary
(XMLNode node, Content classContentTree) Deprecated.Build the member summary contents of the page.void
buildMethodDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the method documentation.void
buildNestedClassInfo
(XMLNode node, Content classInfoTree) Deprecated.If this is an inner class or interface, list the enclosing class or interface.void
buildPropertyDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the property documentation.void
buildSubClassInfo
(XMLNode node, Content classInfoTree) Deprecated.List all the classes extend this one.void
buildSubInterfacesInfo
(XMLNode node, Content classInfoTree) Deprecated.List all the interfaces that extend this one.void
buildSuperInterfacesInfo
(XMLNode node, Content classInfoTree) Deprecated.If this is an interface, list all super interfaces.void
buildTypeParamInfo
(XMLNode node, Content classInfoTree) Deprecated.Build the typeparameters of this class.private void
Deprecated.Copy the doc files for the current ClassDoc if necessary.static ClassBuilder
getInstance
(AbstractBuilder.Context context, ClassDoc classDoc, ClassWriter writer) Deprecated.Construct a new ClassBuilder.getName()
Deprecated.Return the name of this builder.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
build, buildChildren, invokeMethod
-
Field Details
-
ROOT
Deprecated.The root element of the class XML is "ClassDoc".- See Also:
-
classDoc
Deprecated.The class being documented. -
writer
Deprecated.The doclet specific writer. -
isInterface
private final boolean isInterfaceDeprecated.Keep track of whether or not this classdoc is an interface. -
isEnum
private final boolean isEnumDeprecated.Keep track of whether or not this classdoc is an enum. -
contentTree
Deprecated.The content tree for the class documentation.
-
-
Constructor Details
-
ClassBuilder
Deprecated.Construct a new ClassBuilder.- Parameters:
context
- the build contextclassDoc
- the class being documented.writer
- the doclet specific writer.
-
-
Method Details
-
getInstance
public static ClassBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, ClassWriter writer) Deprecated.Construct a new ClassBuilder.- Parameters:
context
- the build contextclassDoc
- the class being documented.writer
- the doclet specific writer.
-
build
Deprecated.Build the documentation.- Specified by:
build
in classAbstractBuilder
- Throws:
IOException
- if there is a problem writing the output
-
getName
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
buildClassDoc
Deprecated.Handles the <ClassDoc> tag.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildClassTree
Deprecated.Build the class tree documentation.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- the content tree to which the documentation will be added
-
buildClassInfo
Deprecated.Build the class information tree documentation.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- the content tree to which the documentation will be added
-
buildTypeParamInfo
Deprecated.Build the typeparameters of this class.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildSuperInterfacesInfo
Deprecated.If this is an interface, list all super interfaces.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildImplementedInterfacesInfo
Deprecated.If this is a class, list all interfaces implemented by this class.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildSubClassInfo
Deprecated.List all the classes extend this one.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildSubInterfacesInfo
Deprecated.List all the interfaces that extend this one.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildInterfaceUsageInfo
Deprecated.If this is an interface, list all classes that implement this interface.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildFunctionalInterfaceInfo
Deprecated.If this is an functional interface, display appropriate message.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildDeprecationInfo
Deprecated.If this class is deprecated, build the appropriate information.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildNestedClassInfo
Deprecated.If this is an inner class or interface, list the enclosing class or interface.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
copyDocFiles
private void copyDocFiles()Deprecated.Copy the doc files for the current ClassDoc if necessary. -
buildClassSignature
Deprecated.Build the signature of the current class.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildClassDescription
Deprecated.Build the class description.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildClassTagInfo
Deprecated.Build the tag information for the current class.- Parameters:
node
- the XML element that specifies which components to documentclassInfoTree
- the content tree to which the documentation will be added
-
buildMemberSummary
Deprecated.Build the member summary contents of the page.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildMemberDetails
Deprecated.Build the member details contents of the page.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- the content tree to which the documentation will be added
-
buildEnumConstantsDetails
Deprecated.Build the enum constants documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildFieldDetails
Deprecated.Build the field documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildPropertyDetails
Deprecated.Build the property documentation.- Parameters:
elements
- the XML elements that specify how a field is documented.- Throws:
Exception
-
buildConstructorDetails
Deprecated.Build the constructor documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildMethodDetails
Deprecated.Build the method documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-