|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectAbstractBuilder
com.sun.xml.bind.taglets.CustomClassBuilder
public class CustomClassBuilder
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
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 |
---|
public static final java.lang.String ROOT
Method Detail |
---|
public static CustomClassBuilder getInstance(Configuration configuration, ClassDoc classDoc, ClassWriter writer) throws java.lang.Exception
configuration
- the current configuration of the doclet.classDoc
- the class being documented.writer
- the doclet specific writer.
java.lang.Exception
public void invokeMethod(java.lang.String methodName, java.lang.Class[] paramClasses, java.lang.Object[] params) throws java.lang.Exception
java.lang.Exception
public void build() throws java.io.IOException
java.io.IOException
public java.lang.String getName()
public void buildClassDoc(java.util.List elements) throws java.lang.Exception
elements
- the XML elements that specify how to document a class.
java.lang.Exception
public void buildClassHeader()
public void buildClassTree()
public void buildImplementedInterfacesInfo()
public void buildSuperInterfacesInfo()
public void buildTypeParamInfo()
public void buildSubClassInfo()
public void buildSubInterfacesInfo()
public void buildInterfaceUsageInfo()
public void buildNestedClassInfo()
public void buildDeprecationInfo()
public void buildClassSignature()
public void buildClassDescription()
public void buildClassTagInfo()
public void buildMemberSummary(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildEnumConstantsDetails(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildFieldDetails(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildConstructorDetails(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildMethodDetails(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildClassFooter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |