Class AbstractBuilder
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
-
- Direct Known Subclasses:
AbstractMemberBuilder
,AnnotationTypeBuilder
,ClassBuilder
,ConstantsSummaryBuilder
,PackageSummaryBuilder
,SerializedFormBuilder
@Deprecated public abstract class AbstractBuilder extends Object
Deprecated.The superclass for all builders. A builder is a class that provides the structure and content of API documentation. A builder is completely doclet independent which means that any doclet can use builders to construct documentation, as long as it impelements the appropriate writer interfaces. For example, if a doclet wanted to useConstantsSummaryBuilder
to build a constant summary, all it has to do is implement the ConstantsSummaryWriter interface and pass it to the builder using a WriterFactory.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
- Author:
- Jamie Ho
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AbstractBuilder.Context
Deprecated.
-
Field Summary
Fields Modifier and Type Field Description protected Configuration
configuration
Deprecated.The configuration used in this run of the doclet.protected Set<PackageDoc>
containingPackagesSeen
Deprecated.Keep track of which packages we have seen for efficiency purposes.protected static boolean
DEBUG
Deprecated.True if we want to print debug output.protected LayoutParser
layoutParser
Deprecated.protected Utils
utils
Deprecated.
-
Constructor Summary
Constructors Constructor Description AbstractBuilder(AbstractBuilder.Context c)
Deprecated.Construct a Builder.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract void
build()
Deprecated.Build the documentation.protected void
build(XMLNode node, Content contentTree)
Deprecated.Build the documentation, as specified by the given XML element.protected void
buildChildren(XMLNode node, Content contentTree)
Deprecated.Build the documentation, as specified by the children of the given XML element.abstract String
getName()
Deprecated.Return the name of this builder.protected void
invokeMethod(String methodName, Class<?>[] paramClasses, Object[] params)
Deprecated.Given the name and parameters, invoke the method in the builder.
-
-
-
Field Detail
-
configuration
protected final Configuration configuration
Deprecated.The configuration used in this run of the doclet.
-
utils
protected final Utils utils
Deprecated.
-
containingPackagesSeen
protected final Set<PackageDoc> containingPackagesSeen
Deprecated.Keep track of which packages we have seen for efficiency purposes. We don't want to copy the doc files multiple times for a single package.
-
layoutParser
protected final LayoutParser layoutParser
Deprecated.
-
DEBUG
protected static final boolean DEBUG
Deprecated.True if we want to print debug output.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AbstractBuilder
public AbstractBuilder(AbstractBuilder.Context c)
Deprecated.Construct a Builder.- Parameters:
configuration
- the configuration used in this run of the doclet.
-
-
Method Detail
-
getName
public abstract String getName()
Deprecated.Return the name of this builder.- Returns:
- the name of the builder.
-
build
public abstract void build() throws IOException
Deprecated.Build the documentation.- Throws:
IOException
- if there is a problem writing the output
-
build
protected void build(XMLNode node, Content contentTree)
Deprecated.Build the documentation, as specified by the given XML element.- Parameters:
node
- the XML element that specifies which component to document.contentTree
- content tree to which the documentation will be added
-
buildChildren
protected void buildChildren(XMLNode node, Content contentTree)
Deprecated.Build the documentation, as specified by the children of the given XML element.- Parameters:
node
- the XML element that specifies which components to document.contentTree
- content tree to which the documentation will be added
-
invokeMethod
protected void invokeMethod(String methodName, Class<?>[] paramClasses, Object[] params) throws Exception
Deprecated.Given the name and parameters, invoke the method in the builder. This method is required to invoke the appropriate build method as instructed by the builder XML file.- Parameters:
methodName
- the name of the method that we would like to invoke.paramClasses
- the types for each parameter.params
- the parameters of the method.- Throws:
Exception
-
-