public class

ExternalRefProvider

extends Object

implements IRefProvider

 java.lang.Object

↳com.parrot.docdown.data.ExternalRefProvider

Overview

A ref provide for external references (-links or -offlinelinks)

Summary

Fields
private final Set<String>packageList

private static final StringPCKG_LIST_FILE_NAME

private final Stringurl

Constructors
publicExternalRefProvider(String url)

publicExternalRefProvider(String url, String pckgListPathName)

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)

private voidloadPackageList(InputStream stream)

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

Fields

private static final String PCKG_LIST_FILE_NAME

private final Set<String> packageList

private final String url

Constructors

public ExternalRefProvider(String url)

public ExternalRefProvider(String url, String pckgListPathName)

Methods

private void loadPackageList(InputStream stream)

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)