public class

RefProvider

extends Object

implements IRefProvider

 java.lang.Object

↳com.parrot.docdown.data.RefProvider

Subclasses:

RefLocator

Overview

Reference provider. Provide references to doc, package, class, field and methods. Search for local reference, external reference.

Summary

Fields
private final List<IRefProvider>apiRefProviderList

private final UnknownRefProviderunknownRefProvider

Constructors
publicRefProvider(DocPageStore store, Collection<IRefProvider> externalProviders)

Constructor

Methods
public DocReferenceablegetClassDocRef(com.sun.javadoc.ClassDoc classDoc)

public DocReferenceablegetExecutableMemberDocRef(com.sun.javadoc.ExecutableMemberDoc executableMemberDoc)

public DocReferenceablegetFieldDocRef(com.sun.javadoc.FieldDoc fieldDoc)

public DocReferenceablegetMarkupDocRef(MarkupDoc markupDoc)

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

public DocReferenceablegetResourceFileRef(ResourceDoc resourceDoc)

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

Fields

private final List<IRefProvider> apiRefProviderList

private final UnknownRefProvider unknownRefProvider

Constructors

public RefProvider(DocPageStore store, Collection<IRefProvider> externalProviders)

Constructor

Parameters:

store: page store instance
externalProviders: collection of external reference provider

Methods

public DocReferenceable getPackageDocRef(com.sun.javadoc.PackageDoc packageDoc)

public DocReferenceable getClassDocRef(com.sun.javadoc.ClassDoc classDoc)

public DocReferenceable getFieldDocRef(com.sun.javadoc.FieldDoc fieldDoc)

public DocReferenceable getExecutableMemberDocRef(com.sun.javadoc.ExecutableMemberDoc executableMemberDoc)

public DocReferenceable getMarkupDocRef(MarkupDoc markupDoc)

public DocReferenceable getResourceFileRef(ResourceDoc resourceDoc)