mjc

org.multijava.mjdoc.mjdoc_142
Class MjExtMethodsDoc

java.lang.Object
  extended byorg.multijava.mjdoc.mjdoc_142.MjDoc
      extended byorg.multijava.mjdoc.mjdoc_142.MjExtMethodsDoc
All Implemented Interfaces:
Comparable, com.sun.javadoc.Doc

public class MjExtMethodsDoc
extends MjDoc

This object holds a list of external methods that are in a single compilation unit.

Author:
David R. Cok

Field Summary
private  com.sun.javadoc.ClassDoc[] cachedImportedClasses
          A cached value (after being initialized) of the array of classes imported into the compilation unit this class is defined in.
private  com.sun.javadoc.PackageDoc[] cachedImportedPackages
          A cached value (after being initialized) of the array of packages imported into the compilation unit this class is defined in.
private  ArrayList methods
          ArrayList of the methods of this class, in the order of declaration.
private  MjPackageDoc pkg
          Holds the containing package.
private  JCompilationUnitType unit
          Holds the compilation unit that this set of external methods is in.
 
Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjDoc
parser
 
Constructor Summary
MjExtMethodsDoc(MjPackageDoc p, JCompilationUnitType unit)
          A constructor for the case when source code is available (which makes javadoc comments and formal parameter identifiers available).
 
Method Summary
 void add(MjMethodDoc m)
          Adds a method
protected  String compareString()
          This generates the String representation used by compareTo.
 com.sun.javadoc.PackageDoc containingPackage()
          Returns the package that contains this compilation unit.
 com.sun.javadoc.ClassDoc[] importedClasses()
          Returns the array of classes imported into the compilation unit this class is defined in.
 com.sun.javadoc.PackageDoc[] importedPackages()
          Returns the array of packages imported into the compilation unit this class is defined in.
 ArrayList methods()
          Returns the external methods in this compilation unit (ArrayList of MjMethodDoc).
 String name()
          Returns the name of the compilation unit; no package name is prefixed.
 String qualifiedName()
          Returns the name of the compilation unit, with the package name prefixed, and with '.' as separator.
 String toString()
          Returns the same thing as qualifiedName().
 JCompilationUnitType unit()
          Returns the compilation unit the external methods are in.
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjDoc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, 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
 

Field Detail

pkg

private MjPackageDoc pkg
Holds the containing package.


unit

private JCompilationUnitType unit
Holds the compilation unit that this set of external methods is in.


methods

private ArrayList methods
ArrayList of the methods of this class, in the order of declaration.


cachedImportedClasses

private com.sun.javadoc.ClassDoc[] cachedImportedClasses
A cached value (after being initialized) of the array of classes imported into the compilation unit this class is defined in.


cachedImportedPackages

private com.sun.javadoc.PackageDoc[] cachedImportedPackages
A cached value (after being initialized) of the array of packages imported into the compilation unit this class is defined in.

Constructor Detail

MjExtMethodsDoc

public MjExtMethodsDoc(MjPackageDoc p,
                       JCompilationUnitType unit)
A constructor for the case when source code is available (which makes javadoc comments and formal parameter identifiers available).

Method Detail

add

public void add(MjMethodDoc m)
Adds a method


methods

public ArrayList methods()
Returns the external methods in this compilation unit (ArrayList of MjMethodDoc).


unit

public JCompilationUnitType unit()
Returns the compilation unit the external methods are in.


name

public String name()
Returns the name of the compilation unit; no package name is prefixed.


qualifiedName

public String qualifiedName()
Returns the name of the compilation unit, with the package name prefixed, and with '.' as separator.


toString

public String toString()
Returns the same thing as qualifiedName().

Overrides:
toString in class Object

compareString

protected String compareString()
This generates the String representation used by compareTo. We use a different method than toString, because toString is not unique in all cases (e.g. methods with the same identifier but different arguments).

Overrides:
compareString in class MjDoc

containingPackage

public com.sun.javadoc.PackageDoc containingPackage()
Returns the package that contains this compilation unit.


importedClasses

public com.sun.javadoc.ClassDoc[] importedClasses()
Returns the array of classes imported into the compilation unit this class is defined in.


importedPackages

public com.sun.javadoc.PackageDoc[] importedPackages()
Returns the array of packages imported into the compilation unit this class is defined in.


mjc

mjc is Copyright (C) 2000-2004 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. mjc is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.