public class

DocPageStore

extends Object

 java.lang.Object

↳com.parrot.docdown.data.page.DocPageStore

Summary

Fields
private final Map<com.sun.javadoc.ClassDoc, ClassPage>classPages

Types (class, interface, enum,...) pages, by classDoc

private final Map<MarkupDoc, MarkupPage>markupPages

Markup pages doc pages, by relative path name

private PackageListPagepackageListPage

Root packages list page

private final Map<com.sun.javadoc.PackageDoc, PackagePage>packagePages

Packages summary pages, by packageDoc

private final Map<ResourceDoc, ResourceFile>resourceFiles

Markup pages doc pages, by relative path name

Constructors
publicDocPageStore()

Instantiate the Doc Page Store

Methods
public voidaddPage(com.sun.javadoc.ClassDoc classDoc, Path outputDir)

public voidaddPage(MarkupDoc markupDoc, Path outputDir)

public voidaddPage(com.sun.javadoc.PackageDoc packageDoc, Path outputDir)

public voidaddPages(com.sun.javadoc.RootDoc rootDoc, Path outputDir)

public voidaddResourceFile(ResourceDoc resourceDoc, Path outputDir)

public ClassPagegetClassPage(com.sun.javadoc.ClassDoc classDoc)

public MarkupPagegetMarkupPage(MarkupDoc markupDoc)

public PackageListPagegetPackageListPage()

public PackagePagegetPackagePage(com.sun.javadoc.PackageDoc packageDoc)

public ResourceFilegetResourceFile(ResourceDoc resourceDoc)

from Object, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Fields

private final Map<MarkupDoc, MarkupPage> markupPages

Markup pages doc pages, by relative path name

private final Map<ResourceDoc, ResourceFile> resourceFiles

Markup pages doc pages, by relative path name

private final Map<com.sun.javadoc.PackageDoc, PackagePage> packagePages

Packages summary pages, by packageDoc

private final Map<com.sun.javadoc.ClassDoc, ClassPage> classPages

Types (class, interface, enum,...) pages, by classDoc

private PackageListPage packageListPage

Root packages list page

Constructors

public DocPageStore()

Instantiate the Doc Page Store

Methods

public void addPages(com.sun.javadoc.RootDoc rootDoc, Path outputDir)

public void addPage(com.sun.javadoc.PackageDoc packageDoc, Path outputDir)

public void addPage(com.sun.javadoc.ClassDoc classDoc, Path outputDir)

public void addPage(MarkupDoc markupDoc, Path outputDir)

public void addResourceFile(ResourceDoc resourceDoc, Path outputDir)

public PackagePage getPackagePage(com.sun.javadoc.PackageDoc packageDoc)

public ClassPage getClassPage(com.sun.javadoc.ClassDoc classDoc)

public MarkupPage getMarkupPage(MarkupDoc markupDoc)

public ResourceFile getResourceFile(ResourceDoc resourceDoc)

public PackageListPage getPackageListPage()