| org.radeox.macro.api.ApiConverter
All known Subclasses: org.radeox.macro.api.BaseApiConverter,
| ApiConverter | | public interface ApiConverter (Code) | | Converts a class name to an API url
author:
Stephan J. Schmidt
version:
$Id: ApiConverter.java 7756 2006-04-13 12:25:49Z ian@caret.cam.ac.uk $ |
| appendUrl | | public void appendUrl(Writer writer, String className) throws IOException(Code) | | Converts a class name to an url and adds the url to an Writer. The url
usually shows som API information about the class e.g. for Java classes
this points to the API documentation on the Sun site.
Parameters:
writer - Writer to add the class url to
Parameters:
className - Namee of the class to create pointer for |
| getBaseUrl | | public String getBaseUrl()(Code) | | Get the base Url for the Converter. A converter creates an API pointer by
combining an base url and the name of a class.
baseUrl Url the converter uses when creating an API pointer |
| getName | | public String getName()(Code) | | Returns the name of the converter. This is used to configure the BaseUrls
and associate them with a concrete converter.
name Name of the Converter, e.g. Java12 |
| setBaseUrl | | public void setBaseUrl(String baseUrl)(Code) | | Set the base Url for the Converter. A converter creates an API pointer by
combining an base url and the name of a class.
Parameters:
baseUrl - Url to use when creating an API pointer |
|
|