AbstractSandBaseTag

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.sandev.generator.tags
Class AbstractSandBaseTag

java.lang.Object
  org.sandev.generator.tags.AbstractSandBaseTag

All Implemented Interfaces:: com.sun.tools.doclets.Taglet

Direct Known Subclasses:: AbstractSandClassTag, AbstractSandFieldTag, AbstractSandGeneralTag

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

Abstract base class for all SAND tag definitions. A tag definition supports SandGenerator tag processing through existence testing, and parameter access methods. It also supports tag documentation through the javadoc taglet interface.

To set up a tag, define a new tag extending the appropriate subclass of this abstract base. To define the tag processing part:

create a factory method, which accepts a FieldDoc or ClassDoc and returns a properly initialized instance if the tag is present, or null. This should be a static method which can be called from a generator. For example:
If this is a repeating tag, then create a factory method which returns an array of initialized instances. For example:
create a static boolean exists(FieldDoc fd) [or the equivalent ClassDoc signature as appropriate] method to allow for simple tag existence checking without the overhead of initializing a new instance.
create methods to access each of the tag parameters (if any), by name. So if additional parameters are added, or changed, then the impact to the generators is minimized. Also this makes it possible to see what generators are accessing which parameters.

To set up the taglet processing part:

create a public String getName() method that returns a String value that:
1. defines the text following the @ sign which this taglet picks up on
2. can be used as a key for a hash lookup. In other words this returned value must always be exactly the same object.
The recommended approach is to declare something like
public static final String TAGNAME = PREFIX + "mytag";
and return this from getName().
create a public static void register(Map tagletMap) method as required by the taglet interface. This method is pure boilerplate and always contains two lines of code. The first creates a new instance of the taglet class, the second calls registerHelper with the map and the instance.
define the public String toString(Tag tag) method which translates the given Tag into an appropriate javadoc comment text. If there will be more than one instance of this tag for a given field or class, then define the public String toString(Tag[] tags) method.
add the tag to the taglet declarations in the build.

See the source of the existing tags for details.

Field Summary
`static java.lang.String`	`PREFIX` This was originally set to the empty string, so all the tags were at the top level.

Constructor Summary
`AbstractSandBaseTag()`

Method Summary
`boolean`	`inConstructor()`
`boolean`	`inField()`
`boolean`	`inMethod()`
`boolean`	`inOverview()`
`boolean`	`inPackage()`
`boolean`	`inType()`
`boolean`	`isInlineTag()`
`static void`	`register(java.util.Map tagletMap)` Register this Taglet.
`static void`	`registerHelper(java.util.Map tagletMap, com.sun.tools.doclets.Taglet tag)` Helper method for `register(java.util.Map)`.
`abstract java.lang.String`	`toString(com.sun.javadoc.Tag tag)` Given the `Tag` representation of this custom tag, return its string representation.
`abstract java.lang.String`	`toString(com.sun.javadoc.Tag[] tags)` Given an array of `Tag`s 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`

Methods inherited from interface com.sun.tools.doclets.Taglet
`getName`

Field Detail

PREFIX

public static final java.lang.String PREFIX

This was originally set to the empty string, so all the tags were at the top level. Now everything starts with sand.

See Also:: Constant Field Values

Constructor Detail