com.sun.xml.bind.taglets
Class CustomClassBuilder

java.lang.Object
  extended by AbstractBuilder
      extended by com.sun.xml.bind.taglets.CustomClassBuilder

public class CustomClassBuilder
extends AbstractBuilder

Builds the summary for a given class. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:
1.5

Field Summary
static java.lang.String ROOT
          The root element of the class XML is "ClassDoc".
 
Method Summary
 void build()
          
 void buildClassDescription()
          Build the class description.
 void buildClassDoc(java.util.List elements)
          Handles the <ClassDoc> tag.
 void buildClassFooter()
          Build the footer of the page.
 void buildClassHeader()
          Build the header of the page.
 void buildClassSignature()
          Build the signature of the current class.
 void buildClassTagInfo()
          Build the tag information for the current class.
 void buildClassTree()
          Build the class tree documentation.
 void buildConstructorDetails(java.util.List elements)
           
 void buildDeprecationInfo()
          If this class is deprecated, print the appropriate information.
 void buildEnumConstantsDetails(java.util.List elements)
           
 void buildFieldDetails(java.util.List elements)
           
 void buildImplementedInterfacesInfo()
          If this is a class, list all interfaces implemented by this class.
 void buildInterfaceUsageInfo()
          If this is an interface, list all classes that implement this interface.
 void buildMemberSummary(java.util.List elements)
           
 void buildMethodDetails(java.util.List elements)
           
 void buildNestedClassInfo()
          If this is an inner class or interface, list the enclosing class or interface.
 void buildSubClassInfo()
          List all the classes extend this one.
 void buildSubInterfacesInfo()
          List all the interfaces that extend this one.
 void buildSuperInterfacesInfo()
          If this is an interface, list all super interfaces.
 void buildTypeParamInfo()
          List the parameters of this class.
static CustomClassBuilder getInstance(Configuration configuration, ClassDoc classDoc, ClassWriter writer)
          Construct a new ClassBuilder.
 java.lang.String getName()
          
 void invokeMethod(java.lang.String methodName, java.lang.Class[] paramClasses, java.lang.Object[] params)
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROOT

public static final java.lang.String ROOT
The root element of the class XML is "ClassDoc".

See Also:
Constant Field Values
Method Detail

getInstance

public static CustomClassBuilder getInstance(Configuration configuration,
                                             ClassDoc classDoc,
                                             ClassWriter writer)
                                      throws java.lang.Exception
Construct a new ClassBuilder.

Parameters:
configuration - the current configuration of the doclet.
classDoc - the class being documented.
writer - the doclet specific writer.
Throws:
java.lang.Exception

invokeMethod

public void invokeMethod(java.lang.String methodName,
                         java.lang.Class[] paramClasses,
                         java.lang.Object[] params)
                  throws java.lang.Exception

Throws:
java.lang.Exception

build

public void build()
           throws java.io.IOException

Throws:
java.io.IOException

getName

public java.lang.String getName()


buildClassDoc

public void buildClassDoc(java.util.List elements)
                   throws java.lang.Exception
Handles the <ClassDoc> tag.

Parameters:
elements - the XML elements that specify how to document a class.
Throws:
java.lang.Exception

buildClassHeader

public void buildClassHeader()
Build the header of the page.


buildClassTree

public void buildClassTree()
Build the class tree documentation.


buildImplementedInterfacesInfo

public void buildImplementedInterfacesInfo()
If this is a class, list all interfaces implemented by this class.


buildSuperInterfacesInfo

public void buildSuperInterfacesInfo()
If this is an interface, list all super interfaces.


buildTypeParamInfo

public void buildTypeParamInfo()
List the parameters of this class.


buildSubClassInfo

public void buildSubClassInfo()
List all the classes extend this one.


buildSubInterfacesInfo

public void buildSubInterfacesInfo()
List all the interfaces that extend this one.


buildInterfaceUsageInfo

public void buildInterfaceUsageInfo()
If this is an interface, list all classes that implement this interface.


buildNestedClassInfo

public void buildNestedClassInfo()
If this is an inner class or interface, list the enclosing class or interface.


buildDeprecationInfo

public void buildDeprecationInfo()
If this class is deprecated, print the appropriate information.


buildClassSignature

public void buildClassSignature()
Build the signature of the current class.


buildClassDescription

public void buildClassDescription()
Build the class description.


buildClassTagInfo

public void buildClassTagInfo()
Build the tag information for the current class.


buildMemberSummary

public void buildMemberSummary(java.util.List elements)
                        throws java.lang.Exception
Throws:
java.lang.Exception

buildEnumConstantsDetails

public void buildEnumConstantsDetails(java.util.List elements)
                               throws java.lang.Exception
Throws:
java.lang.Exception

buildFieldDetails

public void buildFieldDetails(java.util.List elements)
                       throws java.lang.Exception
Throws:
java.lang.Exception

buildConstructorDetails

public void buildConstructorDetails(java.util.List elements)
                             throws java.lang.Exception
Throws:
java.lang.Exception

buildMethodDetails

public void buildMethodDetails(java.util.List elements)
                        throws java.lang.Exception
Throws:
java.lang.Exception

buildClassFooter

public void buildClassFooter()
Build the footer of the page.