org.radeox.macro.api
Class JavaApiConverter

java.lang.Object
  extended byorg.radeox.macro.api.BaseApiConverter
      extended byorg.radeox.macro.api.JavaApiConverter
All Implemented Interfaces:
ApiConverter

public class JavaApiConverter
extends BaseApiConverter

Converts a Java class name to an API url

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

Field Summary
 
Fields inherited from class org.radeox.macro.api.BaseApiConverter
baseUrl
 
Constructor Summary
JavaApiConverter()
           
 
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 getName()
          Returns the name of the converter.
 
Methods inherited from class org.radeox.macro.api.BaseApiConverter
getBaseUrl, setBaseUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavaApiConverter

public JavaApiConverter()
Method Detail

appendUrl

public 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
Specified by:
appendUrl in class BaseApiConverter
Throws:
java.io.IOException

getName

public 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
Specified by:
getName in class BaseApiConverter


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