org.radeox.macro.api
Interface ApiConverter

All Known Implementing Classes:
BaseApiConverter

public interface ApiConverter

Converts a class name to an API url

Version:
$Id: ApiConverter.java,v 1.4 2003/05/23 10:47:25 stephan Exp $
Author:
Stephan J. Schmidt

Method Summary
 void appendUrl(java.io.Writer writer, java.lang.String className)
          Converts a class name to an url and adds the url to an Writer.
 java.lang.String getBaseUrl()
          Get the base Url for the Converter.
 java.lang.String getName()
          Returns the name of the converter.
 void setBaseUrl(java.lang.String baseUrl)
          Set the base Url for the Converter.
 

Method Detail

appendUrl

public void appendUrl(java.io.Writer writer,
                      java.lang.String className)
               throws java.io.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:
java.io.IOException

setBaseUrl

public void setBaseUrl(java.lang.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

public java.lang.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

public java.lang.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


Copyright © 2003 Matthias L. Jugel, Stephan J. Schmidt. All Rights Reserved.