net.sourceforge.taglets.simple.impl
Class DefaultDocletParameter

java.lang.Object
  net.sourceforge.taglets.simple.impl.DefaultDocletParameter

All Implemented Interfaces:

DocletParameter, Parameter

public class DefaultDocletParameter
extends Object
implements DocletParameter

Default DocletParameter implementation.

Version:

1.3 (2008/03/30 12:43:18)

Maintainer:

Bruno Essmann <essmann@sourceforge.net>

Since:

1.3.0

Constructor Summary

DefaultDocletParameter(String destinationDirectory, String docRoot, File sourceFile, int sourceLine, String qualifiedName, com.sun.javadoc.Doc tagHolder)
Creates a new default doclet parameter.

Method Summary

String	getDestinationDirectory() Returns the path of the JavaDoc destination directory.
String	getDocRoot() Returns the relative path to the documentation root.
String	getQualifiedName() The qualified name of the currently parsed program element.
File	getSourceFile() Returns the source file currently parsed.
int	getSourceLine() Returns the line in the source file currently parsed.
com.sun.javadoc.Doc	getTagHolder() Returns the JavaDoc doclet tag holder for the currently processed tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDocletParameter

public DefaultDocletParameter(String destinationDirectory,
                              String docRoot,
                              File sourceFile,
                              int sourceLine,
                              String qualifiedName,
                              com.sun.javadoc.Doc tagHolder)

Creates a new default doclet parameter.

Parameters:

destinationDirectory - the path of the JavaDoc destination directory.

docRoot - the relative path to the documentation root.

sourceFile - the source file currently parsed.

sourceLine - the line in the source file currently parsed.

qualifiedName - the qualified name of the current program element.

tagHolder - the doclet tag holder of the tag currently parsed.

Since:

1.3.0

Method Detail

getDestinationDirectory

public String getDestinationDirectory()

Description copied from interface: Parameter

Returns the path of the JavaDoc destination directory.

Corresponds to the commandline argument -d <directory> of the standard doclet, defaults to the current directory.

Specified by:

getDestinationDirectory in interface Parameter

Returns:

the path of the JavaDoc destination directory.

Since:

1.3.0

getDocRoot

public String getDocRoot()

Description copied from interface: Parameter

Returns the relative path to the documentation root.

Corresponds to the {@docRoot} inline tag.

Warning:

The path returned does not have a trailing slash.

Specified by:

getDocRoot in interface Parameter

Returns:

the relative path to the documentation root.

Since:

1.3.0

getSourceFile

public File getSourceFile()

Description copied from interface: Parameter

Returns the source file currently parsed.

Specified by:

getSourceFile in interface Parameter

Returns:

the source file currently parsed, null if unknown.

Since:

1.3.0

getSourceLine

public int getSourceLine()

Description copied from interface: Parameter

Returns the line in the source file currently parsed.

Numbering in source file starts at 1.

Specified by:

getSourceLine in interface Parameter

Returns:

the line in the source file currently parsed, 0 if unknown.

Since:

1.3.0

getQualifiedName

public String getQualifiedName()

Description copied from interface: Parameter

The qualified name of the currently parsed program element.

Specified by:

getQualifiedName in interface Parameter

Returns:

the qualified name or null if unknown or the current tag parsed is not associated with a program element.

Since:

1.3.0

getTagHolder

public com.sun.javadoc.Doc getTagHolder()

Description copied from interface: DocletParameter

Returns the JavaDoc doclet tag holder for the currently processed tag.

Specified by:

getTagHolder in interface DocletParameter

Returns:

the JavaDoc doclet tag holder for the currently processed tag.

Since:

1.3.0