org.multijava.mjdoc.mjdoc_142
Class MjConstructorDoc

java.lang.Object
  org.multijava.mjdoc.mjdoc_142.MjDoc
      org.multijava.mjdoc.mjdoc_142.MjProgramElementDoc
          org.multijava.mjdoc.mjdoc_142.MjMemberDoc
              org.multijava.mjdoc.mjdoc_142.MjExecutableMemberDoc
                  org.multijava.mjdoc.mjdoc_142.MjConstructorDoc

All Implemented Interfaces:

Comparable, com.sun.javadoc.ConstructorDoc, com.sun.javadoc.Doc, com.sun.javadoc.ExecutableMemberDoc, com.sun.javadoc.MemberDoc, com.sun.javadoc.ProgramElementDoc

public class MjConstructorDoc

extends MjExecutableMemberDoc

implements com.sun.javadoc.ConstructorDoc

This class represents a constructor of a class; it is the bridge between the MJC syntax tree object and the ConstructorDoc interface of javadoc doclets. It wraps a JMethodDeclaration object for the constructor if source code is available; otherwise it uses the corresponding CMethod object.

Author:

David R. Cok

Nested Class Summary

 

Nested classes inherited from class org.multijava.mjdoc.mjdoc_142.MjExecutableMemberDoc

MjExecutableMemberDoc.Comp

 

Field Summary

 

Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjExecutableMemberDoc

 

Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjProgramElementDoc

 

Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjDoc

parser

 

Constructor Summary

MjConstructorDoc(CMethod cm, MjClassDoc container)           Constructs a wrapper object for a CMethod; use when source code (i.e. a JMethodDeclarationType object) is not available.

MjConstructorDoc(JMethodDeclarationType jm, MjClassDoc container)           Constructs a wrapper object for a method; use when source code is available; using this constructor makes the javadoc information available.

 

Method Summary
protected  String	compareString()           Returns a String representation, used for ordering.
boolean	isConstructor()           Returns true since this object represents a constructor.
String	name()           Returns the name of the class (i.e. the constructor identifier) along with any enclosing class names, but without the package name. // !
String	toString()           Returns the name of the class (i.e. the constructor identifier) along with any enclosing class names, but without the package name.

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjExecutableMemberDoc

cmethod, flatSignature, isNative, isSynchronized, jmethod, longModifiers, parameters, parameterSignature, paramTags, qualifiedName, signature, thrownExceptions, throwsTags

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjMemberDoc

isSynthetic

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjProgramElementDoc

containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjDoc

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, notImplemented, position, seeTags, setIncluded, setRawCommentText, setRawCommentText, setRawCommentText, setRawCommentText, tags, tags, tags

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface com.sun.javadoc.ConstructorDoc

qualifiedName

 

Methods inherited from interface com.sun.javadoc.ExecutableMemberDoc

flatSignature, isNative, isSynchronized, parameters, paramTags, signature, thrownExceptions, throwsTags

 

Methods inherited from interface com.sun.javadoc.MemberDoc

isSynthetic

 

Methods inherited from interface com.sun.javadoc.ProgramElementDoc

containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier

 

Methods inherited from interface com.sun.javadoc.Doc

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, position, seeTags, setRawCommentText, tags, tags

 

Constructor Detail

MjConstructorDoc

public MjConstructorDoc(CMethod cm,
                        MjClassDoc container)

Constructs a wrapper object for a CMethod; use when source code (i.e. a JMethodDeclarationType object) is not available.

Parameters:

cm - The CMethod object to be wrappped

container - The class that contains this constructor

MjConstructorDoc

public MjConstructorDoc(JMethodDeclarationType jm,
                        MjClassDoc container)

Constructs a wrapper object for a method; use when source code is available; using this constructor makes the javadoc information available.

Parameters:

jm - The CMethod object to be wrappped

container - The class that contains this constructor

isConstructor

public boolean isConstructor()

Returns true since this object represents a constructor.

Specified by:

isConstructor in interface com.sun.javadoc.Doc

Overrides:

isConstructor in class MjDoc

name

public String name()

Returns the name of the class (i.e. the constructor identifier) along with any enclosing class names, but without the package name. // !FIXME! DOes not agree with Method or Executabale method

Specified by:

name in interface com.sun.javadoc.Doc

toString

public String toString()

Returns the name of the class (i.e. the constructor identifier) along with any enclosing class names, but without the package name.

Overrides:

toString in class MjExecutableMemberDoc

compareString

protected String compareString()

Returns a String representation, used for ordering.

Overrides:

compareString in class MjExecutableMemberDoc