org.freehep.tools.doclet
Class ClassUseMapper

java.lang.Object
  org.freehep.tools.doclet.ClassUseMapper

public class ClassUseMapper

extends Object

Since:

JDK1.2

Author:

Robert G. Field

Source Code:

ClassUseMapper.java

Field Summary

Map	classToClass Mapping of ClassDocs to set of ClassDoc used by that class.
Map	classToConstructorArgs Mapping of ClassDocs to list of ConstructorDoc having that class as an arg.
Map	classToConstructorThrows Mapping of ClassDocs to list of ConstructorDoc which throws that class.
Map	classToField Mapping of ClassDocs to list of FieldDoc declared as that class.
Map	classToImplementingClass Mapping of ClassDocs to list of ClassDoc which implement this interface.
Map	classToMethodArgs Mapping of ClassDocs to list of MethodDoc having that class as an arg.
Map	classToMethodReturn Mapping of ClassDocs to list of MethodDoc returning that class.
Map	classToMethodThrows Mapping of ClassDocs to list of MethodDoc which throws that class.
Map	classToPackage Mapping of ClassDocs to set of PackageDoc used by that class.
Map	classToSubclass Mapping of ClassDocs to list of ClassDoc which are direct or indirect subclasses of that class.
Map	classToSubinterface Mapping of ClassDocs to list of ClassDoc which are direct or indirect subinterfaces of that interface.

Method Summary

static void

generate(ConfigurationStandard configuration, com.sun.tools.doclets.ClassTree classtree) Write out class use pages.

Methods inherited from class java.lang.Object

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

Field Detail

classToPackage

public Map classToPackage

Mapping of ClassDocs to set of PackageDoc used by that class. Entries may be null.

classToClass

public Map classToClass

Mapping of ClassDocs to set of ClassDoc used by that class. Entries may be null.

classToSubclass

public Map classToSubclass

Mapping of ClassDocs to list of ClassDoc which are direct or indirect subclasses of that class. Entries may be null.

classToSubinterface

public Map classToSubinterface

Mapping of ClassDocs to list of ClassDoc which are direct or indirect subinterfaces of that interface. Entries may be null.

classToImplementingClass

public Map classToImplementingClass

Mapping of ClassDocs to list of ClassDoc which implement this interface. Entries may be null.

classToField

public Map classToField

Mapping of ClassDocs to list of FieldDoc declared as that class. Entries may be null.

classToMethodReturn

public Map classToMethodReturn

Mapping of ClassDocs to list of MethodDoc returning that class. Entries may be null.

classToMethodArgs

public Map classToMethodArgs

Mapping of ClassDocs to list of MethodDoc having that class as an arg. Entries may be null.

classToMethodThrows

public Map classToMethodThrows

Mapping of ClassDocs to list of MethodDoc which throws that class. Entries may be null.

classToConstructorArgs

public Map classToConstructorArgs

Mapping of ClassDocs to list of ConstructorDoc having that class as an arg. Entries may be null.

classToConstructorThrows

public Map classToConstructorThrows

Mapping of ClassDocs to list of ConstructorDoc which throws that class. Entries may be null.

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.tools.doclets.ClassTree classtree)

Write out class use pages.

Throws:

com.sun.tools.doclets.DocletAbortException