org.schmant.task.text.apilinks
Class ApiLink

java.lang.Object
  org.schmant.task.text.apilinks.ApiLink

public class ApiLink
extends Object

This object contains a package prefix, such as java.net. and an URL to the index page of the Javadoc site where the API documentation for Java packages can be found, such as http://java.sun.com/javase/6/docs/api/index.html.

Instances of this class are immutable.

Since:

0.8

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Constructor Summary

ApiLink(String packagePrefix, String urlToIndexPage)
Create a new API link.

Method Summary

String	getPackagePrefix()
String	getUrlToIndexPage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiLink

public ApiLink(String packagePrefix,
               String urlToIndexPage)

Create a new API link.

Parameters:

packagePrefix - A package name. End the name with a dot (.) in order to no include packages with similar names by accident.

urlToIndexPage - URL to the index page of the Javadocs for the package. If this is a relative URL, it should be relative to the base directory for the Javadocs.

Method Detail

getPackagePrefix

public String getPackagePrefix()

getUrlToIndexPage

public String getUrlToIndexPage()