org.codehaus.mojo.servicedocgen.descriptor

Class JavaDocDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.JavaDocDescriptor

public class JavaDocDescriptor
extends Object

Descriptor for URL mapping configuration to create JavaDoc links.

Author:

hohwille

Constructor Summary

Constructors

Constructor and Description
JavaDocDescriptor() The constructor.
JavaDocDescriptor(String packagePrefix, String url) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getPackagePrefix()
String	getUrl()
void	setPackagePrefix(String packagePrefix)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDocDescriptor

public JavaDocDescriptor()

The constructor.

JavaDocDescriptor

public JavaDocDescriptor(String packagePrefix,
                         String url)

The constructor.

Parameters:

packagePrefix - - see getPackagePrefix().

url - - see getUrl().

Method Detail

getPackagePrefix

public String getPackagePrefix()

Returns:

the prefix of the Package mapped to this JavaDoc URL.

setPackagePrefix

public void setPackagePrefix(String packagePrefix)

Parameters:

packagePrefix - is the packagePrefix to set

getUrl

public String getUrl()

Returns:

the base URL of the JavaDoc for this package prefix.

setUrl

public void setUrl(String url)

Parameters:

url - is the url to set