ApiConverter (sakai-radeox 22.0 API)

All Known Implementing Classes:

BaseApiConverter, JavaApiConverter, RubyApiConverter
```
public interface ApiConverter
```
Converts a class name to an API url

Version:

$Id$

Author:

Stephan J. Schmidt

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`appendUrl(Writer writer, String className)`	Converts a class name to an url and adds the url to an Writer.
`String`	`getBaseUrl()`	Get the base Url for the Converter.
`String`	`getName()`	Returns the name of the converter.
`void`	`setBaseUrl(String baseUrl)`	Set the base Url for the Converter.

- Method Detail
  - appendUrl
```
void appendUrl(Writer writer,
               String className)
        throws IOException
```
    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
    
    className - Namee of the class to create pointer for
    
    Throws:
    
    IOException
  - setBaseUrl
```
void setBaseUrl(String baseUrl)
```
    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
  - getBaseUrl
```
String getBaseUrl()
```
    Get the base Url for the Converter. A converter creates an API pointer by combining an base url and the name of a class.
    
    Returns:
    
    baseUrl Url the converter uses when creating an API pointer
  - getName
```
String getName()
```
    Returns the name of the converter. This is used to configure the BaseUrls and associate them with a concrete converter.
    
    Returns:
    
    name Name of the Converter, e.g. Java12