RubyApiConverter (sakai-radeox 22.0 API)

java.lang.Object
- org.radeox.macro.api.BaseApiConverter
- - org.radeox.macro.api.RubyApiConverter

All Implemented Interfaces:

ApiConverter
```
public class RubyApiConverter
extends BaseApiConverter
```
Converts a Ruby class name to an Ruby api doku url

Version:

$Id: RubyApiConverter.java 7707 2006-04-12 17:30:19Z ian@caret.cam.ac.uk $

Author:

Stephan J. Schmidt

Field Summary
- Fields inherited from class org.radeox.macro.api.BaseApiConverter
  baseUrl

Constructor Summary

Constructors
Constructor Description

RubyApiConverter()

Method Summary

All Methods Instance Methods Concrete 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`	`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
  - RubyApiConverter
```
public RubyApiConverter()
```
- Method Detail
  - appendUrl
```
public void appendUrl(Writer writer,
                      String className)
               throws 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
    
    Parameters:
    
    writer - Writer to add the class url to
    
    className - Namee of the class to create pointer for
    
    Throws:
    
    IOException
  - getName
```
public 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
    
    Returns:
    
    name Name of the Converter, e.g. Java12