Class SerializedFormBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.SerializedFormBuilder
Deprecated.
Builds the serialized form.
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 Content
Deprecated.The content that will be added to the serialized form documentation tree.private ClassDoc
Deprecated.The current class being documented.protected MemberDoc
Deprecated.The current member being documented.private PackageDoc
Deprecated.The current package being documented.Deprecated.The writer for serializable fields.Deprecated.The writer for serializable method documentation.static final String
Deprecated.The root element of the serialized form XML is "SerializedForm".private static final String
Deprecated.The header for the serial version UID.private SerializedFormWriter
Deprecated.The writer for this builder.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Deprecated.Construct a new SerializedFormBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
Deprecated.Build the serialized form.void
buildClassContent
(XMLNode node, Content classTree) Deprecated.Build the summaries for the methods and fields.void
buildClassSerializedForm
(XMLNode node, Content packageSerializedTree) Deprecated.Build the class serialized form.void
buildDeprecatedMethodInfo
(XMLNode node, Content methodsContentTree) Deprecated.Build the deprecated method description.void
buildFieldDeprecationInfo
(XMLNode node, Content fieldsContentTree) Deprecated.Build the field deprecation information.void
buildFieldHeader
(XMLNode node, Content classContentTree) Deprecated.Build the field header.void
buildFieldInfo
(XMLNode node, Content fieldsContentTree) Deprecated.Build the field information.void
buildFieldSerializationOverview
(ClassDoc classDoc, Content classContentTree) Deprecated.Build the serialization overview for the given class.void
buildFieldSubHeader
(XMLNode node, Content fieldsContentTree) Deprecated.Build the field sub header.void
buildMethodDescription
(XMLNode node, Content methodsContentTree) Deprecated.Build method description.void
buildMethodInfo
(XMLNode node, Content methodsContentTree) Deprecated.Build the information for the method.void
buildMethodSubHeader
(XMLNode node, Content methodsContentTree) Deprecated.Build the method sub header.void
buildMethodTags
(XMLNode node, Content methodsContentTree) Deprecated.Build the method tags.void
buildPackageHeader
(XMLNode node, Content packageSerializedTree) Deprecated.Build the package header.void
buildPackageSerializedForm
(XMLNode node, Content serializedSummariesTree) Deprecated.Build the package serialized form for the current package being processed.void
buildSerialFieldTagsInfo
(Content serializableFieldsTree) Deprecated.Build the serial field tags information.void
buildSerializableFields
(XMLNode node, Content classContentTree) Deprecated.Build the summaries for the fields that belong to the given class.void
buildSerializableMethods
(XMLNode node, Content classContentTree) Deprecated.Build the summaries for the methods that belong to the given class.void
buildSerializedForm
(XMLNode node, Content serializedTree) Deprecated.Build the serialized form.void
buildSerializedFormSummaries
(XMLNode node, Content serializedTree) Deprecated.Build the serialized form summaries.void
buildSerialUIDInfo
(XMLNode node, Content classTree) Deprecated.Build the serial UID information for the given class.static SerializedFormBuilder
getInstance
(AbstractBuilder.Context context) Deprecated.Construct a new SerializedFormBuilder.getName()
Deprecated.Return the name of this builder.private boolean
serialClassFoundToDocument
(ClassDoc[] classes) Deprecated.Return true if any of the given classes have a @serialinclude tag.private static boolean
Deprecated.Return true if the given ClassDoc should be included in the serialized form.private static boolean
serialDocInclude
(Doc doc) Deprecated.Return true if the given Doc should be included in the serialized form.static boolean
serialInclude
(Doc doc) Deprecated.Return true if the given Doc should be included in the serialized form.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
build, buildChildren, invokeMethod
-
Field Details
-
NAME
Deprecated.The root element of the serialized form XML is "SerializedForm".- See Also:
-
writer
Deprecated.The writer for this builder. -
fieldWriter
Deprecated.The writer for serializable fields. -
methodWriter
Deprecated.The writer for serializable method documentation. -
SERIAL_VERSION_UID_HEADER
Deprecated.The header for the serial version UID. Save the string here instead of the properties file because we do not want this string to be localized.- See Also:
-
currentPackage
Deprecated.The current package being documented. -
currentClass
Deprecated.The current class being documented. -
currentMember
Deprecated.The current member being documented. -
contentTree
Deprecated.The content that will be added to the serialized form documentation tree.
-
-
Constructor Details
-
SerializedFormBuilder
Deprecated.Construct a new SerializedFormBuilder.- Parameters:
context
- the build context.
-
-
Method Details
-
getInstance
Deprecated.Construct a new SerializedFormBuilder.- Parameters:
context
- the build context.
-
build
Deprecated.Build the serialized form.- 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.
-
buildSerializedForm
Deprecated.Build the serialized form.- Parameters:
node
- the XML element that specifies which components to documentserializedTree
- content tree to which the documentation will be added- Throws:
Exception
-
buildSerializedFormSummaries
Deprecated.Build the serialized form summaries.- Parameters:
node
- the XML element that specifies which components to documentserializedTree
- content tree to which the documentation will be added
-
buildPackageSerializedForm
Deprecated.Build the package serialized form for the current package being processed.- Parameters:
node
- the XML element that specifies which components to documentserializedSummariesTree
- content tree to which the documentation will be added
-
buildPackageHeader
Deprecated.Build the package header.- Parameters:
node
- the XML element that specifies which components to documentpackageSerializedTree
- content tree to which the documentation will be added
-
buildClassSerializedForm
Deprecated.Build the class serialized form.- Parameters:
node
- the XML element that specifies which components to documentpackageSerializedTree
- content tree to which the documentation will be added
-
buildSerialUIDInfo
Deprecated.Build the serial UID information for the given class.- Parameters:
node
- the XML element that specifies which components to documentclassTree
- content tree to which the serial UID information will be added
-
buildClassContent
Deprecated.Build the summaries for the methods and fields.- Parameters:
node
- the XML element that specifies which components to documentclassTree
- content tree to which the documentation will be added
-
buildSerializableMethods
Deprecated.Build the summaries for the methods that belong to the given class.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- content tree to which the documentation will be added
-
buildMethodSubHeader
Deprecated.Build the method sub header.- Parameters:
node
- the XML element that specifies which components to documentmethodsContentTree
- content tree to which the documentation will be added
-
buildDeprecatedMethodInfo
Deprecated.Build the deprecated method description.- Parameters:
node
- the XML element that specifies which components to documentmethodsContentTree
- content tree to which the documentation will be added
-
buildMethodInfo
Deprecated.Build the information for the method.- Parameters:
node
- the XML element that specifies which components to documentmethodsContentTree
- content tree to which the documentation will be added
-
buildMethodDescription
Deprecated.Build method description.- Parameters:
node
- the XML element that specifies which components to documentmethodsContentTree
- content tree to which the documentation will be added
-
buildMethodTags
Deprecated.Build the method tags.- Parameters:
node
- the XML element that specifies which components to documentmethodsContentTree
- content tree to which the documentation will be added
-
buildFieldHeader
Deprecated.Build the field header.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- content tree to which the documentation will be added
-
buildFieldSerializationOverview
Deprecated.Build the serialization overview for the given class.- Parameters:
classDoc
- the class to print the overview for.classContentTree
- content tree to which the documentation will be added
-
buildSerializableFields
Deprecated.Build the summaries for the fields that belong to the given class.- Parameters:
node
- the XML element that specifies which components to documentclassContentTree
- content tree to which the documentation will be added
-
buildFieldSubHeader
Deprecated.Build the field sub header.- Parameters:
node
- the XML element that specifies which components to documentfieldsContentTree
- content tree to which the documentation will be added
-
buildFieldDeprecationInfo
Deprecated.Build the field deprecation information.- Parameters:
node
- the XML element that specifies which components to documentfieldsContentTree
- content tree to which the documentation will be added
-
buildSerialFieldTagsInfo
Deprecated.Build the serial field tags information.- Parameters:
serializableFieldsTree
- content tree to which the documentation will be added
-
buildFieldInfo
Deprecated.Build the field information.- Parameters:
node
- the XML element that specifies which components to documentfieldsContentTree
- content tree to which the documentation will be added
-
serialInclude
Deprecated.Return true if the given Doc should be included in the serialized form.- Parameters:
doc
- the Doc object to check for serializability.
-
serialClassInclude
Deprecated.Return true if the given ClassDoc should be included in the serialized form.- Parameters:
cd
- the ClassDoc object to check for serializability.
-
serialDocInclude
Deprecated.Return true if the given Doc should be included in the serialized form.- Parameters:
doc
- the Doc object to check for serializability.
-
serialClassFoundToDocument
Deprecated.Return true if any of the given classes have a @serialinclude tag.- Parameters:
classes
- the classes to check.- Returns:
- true if any of the given classes have a @serialinclude tag.
-