org.mule.devkit.doclet

Class FederatedSite

java.lang.Object

org.mule.devkit.doclet.FederatedSite

public final class FederatedSite
extends Object

A remote source of documentation that can be linked against. A federated site represents a library that has packages, classes, and members that may be referenced or shared across codebases.

Field Summary

Fields

Modifier and Type	Field and Description
static String	XML_API_PATH

Constructor Summary

Constructors

Constructor and Description
FederatedSite(String name, URL baseUrl)
FederatedSite(String name, URL baseUrl, String xml) Constructs a federated site using an xml file not contained on the site itself.

Method Summary

Methods

Modifier and Type	Method and Description
ApiInfo	apiInfo()
URL	baseUrl()
String	linkFor(String htmlPage)
String	name()

Methods inherited from class java.lang.Object

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

Field Detail

XML_API_PATH

public static final String XML_API_PATH

See Also:

Constant Field Values

Constructor Detail

FederatedSite

public FederatedSite(String name,
             URL baseUrl)
              throws ApiParseException

Throws:

ApiParseException

FederatedSite

public FederatedSite(String name,
             URL baseUrl,
             String xml)
              throws ApiParseException

Constructs a federated site using an xml file not contained on the site itself.

Throws:

ApiParseException

Method Detail

linkFor

public String linkFor(String htmlPage)

name

public String name()

apiInfo

public ApiInfo apiInfo()

baseUrl

public URL baseUrl()