org.radeox.macro.api
Class BaseApiConverter

java.lang.Object
  |
  +--org.radeox.macro.api.BaseApiConverter
All Implemented Interfaces:
ApiConverter
Direct Known Subclasses:
JavaApiConverter, RubyApiConverter

public abstract class BaseApiConverter
extends java.lang.Object
implements ApiConverter

Base class for API converters, stores a base URL

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

Field Summary
protected  java.lang.String baseUrl
           
 
Constructor Summary
BaseApiConverter()
           
 
Method Summary
abstract  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.
abstract  java.lang.String getName()
          Returns the name of the converter.
 void setBaseUrl(java.lang.String baseUrl)
          Set the base Url for the Converter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

baseUrl

protected java.lang.String baseUrl
Constructor Detail

BaseApiConverter

public BaseApiConverter()
Method Detail

appendUrl

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

Specified by:
appendUrl in interface ApiConverter
Parameters:
writer - Writer to add the class url to
className - Namee of the class to create pointer for
java.io.IOException

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)
Description copied from interface: ApiConverter
Set the base Url for the Converter. A converter creates an API pointer by combining an base url and the name of a class.

Specified by:
setBaseUrl in interface ApiConverter
Parameters:
baseUrl - Url to use when creating an API pointer

getBaseUrl

public java.lang.String getBaseUrl()
Description copied from interface: ApiConverter
Get the base Url for the Converter. A converter creates an API pointer by combining an base url and the name of a class.

Specified by:
getBaseUrl in interface ApiConverter
Returns:
baseUrl Url the converter uses when creating an API pointer

getName

public abstract java.lang.String getName()
Description copied from interface: ApiConverter
Returns the name of the converter. This is used to configure the BaseUrls and associate them with a concrete converter.

Specified by:
getName in interface ApiConverter
Returns:
name Name of the Converter, e.g. Java12


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