org.freehep.tools.doclet.tags
Class AbstractInlineTaglet

java.lang.Object
  org.freehep.tools.doclet.tags.AbstractInlineTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

DocRootTaglet, InheritDocTaglet, ValueTaglet

public abstract class AbstractInlineTaglet

extends Object

implements com.sun.tools.doclets.Taglet

An abstract inline taglet that outputs HTML.

Since:

1.4

Author:

Jamie Ho

Source Code:

AbstractInlineTaglet.java

Field Summary

protected String

name The name of this inline tag.

Constructor Summary

AbstractInlineTaglet()

Method Summary

String	getName() Return the name of this custom tag.
boolean	inConstructor() Will return false since this is an inline tag.
boolean	inField() Will return false since this is an inline tag.
boolean	inMethod() Will return false since this is an inline tag.
boolean	inOverview() Will return false since this is an inline tag.
boolean	inPackage() Will return false since this is an inline tag.
boolean	inType() Will return false since this is an inline tag.
boolean	isInlineTag() Will return true since this is an inline tag.
String	toString(com.sun.javadoc.Tag tag) This method should not be called because this Taglet requires more information to output to generate output.
String	toString(com.sun.javadoc.Tag[] tags) This method should not be called since this taglet does not support the conversion of arrays on inline tags to a string.
abstract String	toString(com.sun.javadoc.Tag tag, com.sun.javadoc.Doc doc, HtmlStandardWriter writer) Given the Tag representation of this custom tag, return its string representation.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The name of this inline tag.

Constructor Detail

AbstractInlineTaglet

public AbstractInlineTaglet()

Method Detail

getName

public String getName()

Return the name of this custom tag.

Specified by:

getName in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Will return false since this is an inline tag.

Specified by:

inField in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

inConstructor

public boolean inConstructor()

Will return false since this is an inline tag.

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

inMethod

public boolean inMethod()

Will return false since this is an inline tag.

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

inOverview

public boolean inOverview()

Will return false since this is an inline tag.

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

inPackage

public boolean inPackage()

Will return false since this is an inline tag.

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

inType

public boolean inType()

Will return false since this is an inline tag.

Specified by:

inType in interface com.sun.tools.doclets.Taglet

Returns:

false since this is an inline tag.

isInlineTag

public boolean isInlineTag()

Will return true since this is an inline tag.

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

Returns:

true since this is an inline tag.

toString

public String toString(com.sun.javadoc.Tag tag)

This method should not be called because this Taglet requires more information to output to generate output.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Parameters:

tag - a tag representing this inline tag.

Returns:

null since this Taglet requires more information to output to generate output.

toString

public String toString(com.sun.javadoc.Tag[] tags)

This method should not be called since this taglet does not support the conversion of arrays on inline tags to a string.

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Parameters:

tags - the array of Tags representing of this custom tag.

Returns:

null since this taglet does not support the conversion of arrays on inline tags to a string.

toString

public abstract String toString(com.sun.javadoc.Tag tag,
                                com.sun.javadoc.Doc doc,
                                HtmlStandardWriter writer)

Given the Tag representation of this custom tag, return its string representation.

Parameters:

tag - he Tag representation of this custom tag.

doc - the field that holds this tag.

writer - the HtmlStandardWriter used to write this inline tag.