Class JavaMemberDocs

java.lang.Object

uno.anahata.ai.nb.model.java2.JavaTypeDocs

uno.anahata.ai.nb.model.java2.JavaMemberDocs

public class JavaMemberDocs
extends JavaTypeDocs

A rich result object that represents the outcome of a Javadoc retrieval operation for a JavaMember. It extends JavaTypeDocs to maintain consistency in the polymorphic API.

Field Summary

Fields inherited from class JavaTypeDocs

javadoc, javaType

Constructor Summary

Constructors

Constructor	Description
JavaMemberDocs(JavaMember member)	Constructs a new JavaMemberDocs and attempts to retrieve the Javadoc for the given JavaMember.

Method Summary

Modifier and Type	Method	Description
JavaMember	getMember()

Methods inherited from class JavaTypeDocs

cleanJavadoc

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaMemberDocs

public JavaMemberDocs(JavaMember member)
               throws Exception

Constructs a new JavaMemberDocs and attempts to retrieve the Javadoc for the given JavaMember.

Parameters:

member - the member to retrieve Javadoc for.

Throws:

Exception - if the Javadoc cannot be retrieved.

Method Details

getMember

public JavaMember getMember()