org.sandev.generator.tags
Class NodeTagSend

java.lang.Object
  org.sandev.generator.tags.AbstractSandBaseTag
      org.sandev.generator.tags.AbstractSandClassTag
          org.sandev.generator.tags.AbstractSandNodeTag
              org.sandev.generator.tags.NodeTagSend

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class NodeTagSend
extends AbstractSandNodeTag

Handle @sand.send declarations.

Declares that this node can broadcast the specified message class to current subscribers.

parameters:

1. fully qualified outbound message class name.
2. comment (optional)

example effect: A corresponding send method is generated in the node base class, with a corresponding messaging configuration in the node instance class.

Field Summary

protected java.lang.String	comment Any comment text that was specified for this tag declaration
static java.lang.String	CORENAME The core name of this tag.
protected java.lang.String	outboundMessage The fully qualified name of the outbound message class for this asynchronous send.
static java.lang.String	TAGNAME Our fixed name, used for hash lookup and text parsing.

Fields inherited from class org.sandev.generator.tags.AbstractSandBaseTag

PREFIX

Constructor Summary

NodeTagSend()

Method Summary

static boolean	exists(com.sun.javadoc.ClassDoc cd) Returns true if the given class contains this tag, false otherwise.
java.lang.String	getComment() accessor for comment
java.lang.String	getCoreMethodSig(boolean shortNames) Return the undecorated signature of the messaging method generated for this tag.
java.lang.String	getInstanceConfigParam() Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.
java.lang.String	getName() Return our tag name
static NodeTagSend[]	getNodeTagSends(com.sun.javadoc.ClassDoc cd) Factory method to return the NodeTagSend elements of a class.
java.lang.String	getOutboundMessage() accessor for outboundMessage
void	init(com.sun.javadoc.Tag tag) Initialize this instance from the tag information.
static void	register(java.util.Map tagletMap) Registers this taglet when triggered by the taglet declaration being loaded in as part of the build.
void	setComment(java.lang.String text) mutator for comment
void	setOutboundMessage(java.lang.String text) mutator for outboundMessage
java.lang.String	toString(com.sun.javadoc.Tag tag) Return a documentation description of this tag.
java.lang.String	toString(com.sun.javadoc.Tag[] tags) Return a documentation description of these tags.

Methods inherited from class org.sandev.generator.tags.AbstractSandClassTag

inType

Methods inherited from class org.sandev.generator.tags.AbstractSandBaseTag

inConstructor, inField, inMethod, inOverview, inPackage, isInlineTag, registerHelper

Methods inherited from class java.lang.Object

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

Field Detail

CORENAME

public static final java.lang.String CORENAME

The core name of this tag.

See Also:

Constant Field Values

outboundMessage

protected java.lang.String outboundMessage

The fully qualified name of the outbound message class for this asynchronous send.

comment

protected java.lang.String comment

Any comment text that was specified for this tag declaration

TAGNAME

public static final java.lang.String TAGNAME

Our fixed name, used for hash lookup and text parsing.

See Also:

Constant Field Values

Constructor Detail

NodeTagSend

public NodeTagSend()

Method Detail

getOutboundMessage

public java.lang.String getOutboundMessage()

accessor for outboundMessage

setOutboundMessage

public void setOutboundMessage(java.lang.String text)

mutator for outboundMessage

getComment

public java.lang.String getComment()

accessor for comment

setComment

public void setComment(java.lang.String text)

mutator for comment

init

public void init(com.sun.javadoc.Tag tag)

Initialize this instance from the tag information.

getCoreMethodSig

public java.lang.String getCoreMethodSig(boolean shortNames)

Return the undecorated signature of the messaging method generated for this tag. If shortNames is true, then use the unqualified names of the message parameters.

getInstanceConfigParam

public java.lang.String getInstanceConfigParam()

Return the name of the NodeInstance data member which will hold the messaging configuration for this declaration.

getName

public java.lang.String getName()

Return our tag name

register

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

Registers this taglet when triggered by the taglet declaration being loaded in as part of the build.

toString

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

Return a documentation description of this tag. Passthrough to toString(Tag[] tags) for consistent processing. We always want a listing, even with only one tag present.

Specified by:

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

Specified by:

toString in class AbstractSandBaseTag

Parameters:

tag - the Tag representation of this custom tag.

toString

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

Return a documentation description of these tags. We essentially just init ourselves with each tag description and then dump out some descriptive text.

Specified by:

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

Specified by:

toString in class AbstractSandBaseTag

Parameters:

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

getNodeTagSends

public static NodeTagSend[] getNodeTagSends(com.sun.javadoc.ClassDoc cd)

Factory method to return the NodeTagSend elements of a class. Returns an empty array if no elements were found.

exists

public static boolean exists(com.sun.javadoc.ClassDoc cd)

Returns true if the given class contains this tag, false otherwise.