doc.doclets
Class RatingTaglet

java.lang.Object
  doc.doclets.RatingTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class RatingTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

A taglet that deals with Ptolemy code rating tags. This class was based on Sun's example taglets.

Since:

Ptolemy II 4.0

Version:

$Id: RatingTaglet.java 43472 2006-08-21 23:16:56Z cxh $

Author:

Steve Neuendorffer, Contributor: Christopher Brooks

Accepted Rating:

Red (neuendor)

Proposed Rating:

Red (neuendor)

Field Summary

private java.lang.String	_name
private java.lang.String	_tagName

Constructor Summary

RatingTaglet(java.lang.String name, java.lang.String tagName)
Create a new RatingTaglet that deals with tags of the given name that has the given tagName as a string.

Method Summary

private static void	_register(java.util.Map tagletMap, com.sun.tools.doclets.Taglet taglet)
java.lang.String	getName() Return the name of this custom tag.
boolean	inConstructor() Return true if the tag can annotate a constructor.
boolean	inField() Return true if the tag can annotate a field.
boolean	inMethod() Return true if the tag can annotate a method.
boolean	inOverview() Return true if the tag can annotate a class.
boolean	inPackage() Return true if the tag can annotate a package.
boolean	inType() Return true if the tag can annotate a class or interface.
boolean	isInlineTag() Return true if the tag is an inline tag.
static void	register(java.util.Map tagletMap) Register this Taglet.
java.lang.String	toString(com.sun.javadoc.Tag tag) Given the Tag representation of this custom tag, return its string representation.
java.lang.String	toString(com.sun.javadoc.Tag[] tags) Given an array of Tags representing 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

private java.lang.String _name

_tagName

private java.lang.String _tagName

Constructor Detail

RatingTaglet

public RatingTaglet(java.lang.String name,
                    java.lang.String tagName)

Create a new RatingTaglet that deals with tags of the given name that has the given tagName as a string.

Parameters:

name - The name of the taglet.

tagName - The tagName.

Method Detail

getName

public java.lang.String getName()

Return the name of this custom tag.

Specified by:

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

inField

public boolean inField()

Return true if the tag can annotate a field.

Specified by:

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

Returns:

false.

inConstructor

public boolean inConstructor()

Return true if the tag can annotate a constructor.

Specified by:

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

Returns:

false.

inMethod

public boolean inMethod()

Return true if the tag can annotate a method.

Specified by:

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

Returns:

false.

inOverview

public boolean inOverview()

Return true if the tag can annotate a class.

Specified by:

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

Returns:

true.

inPackage

public boolean inPackage()

Return true if the tag can annotate a package.

Specified by:

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

Returns:

true.

inType

public boolean inType()

Return true if the tag can annotate a class or interface.

Specified by:

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

Returns:

true.

isInlineTag

public boolean isInlineTag()

Return true if the tag is an inline tag.

Specified by:

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

Returns:

false.

register

public static void register(java.util.Map tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

toString

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

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

Specified by:

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

Parameters:

tag - the Tag representation of this custom tag.

Returns:

The string representation.

toString

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

Given an array of Tags representing this custom tag, return its string representation.

Specified by:

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

Parameters:

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

Returns:

The string representation.

_register

private static void _register(java.util.Map tagletMap,
                              com.sun.tools.doclets.Taglet taglet)