org.sandev.generator.tags
Class StructTagStructmessage

java.lang.Object
  org.sandev.generator.tags.AbstractSandBaseTag
      org.sandev.generator.tags.AbstractSandClassTag
          org.sandev.generator.tags.AbstractSandStructTag
              org.sandev.generator.tags.StructTagStructmessage

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class StructTagStructmessage

extends AbstractSandStructTag

Handle the @sand.structmessage declaration.

Declares zero or more struct message characteristics as being set. You can specify zero or more characteristics of the struct message:

• abstract
• transmit
• persist
• authuser
• tree

Comments are not supported for this tag.

abstract:

Declares that instances of this SandStructMessage are never actually created. The struct exists solely as a common base for other structs which extend it. The system can use this indicator to optimize code generation and storage structures.

transmit:

Declares that the generated SandStructMessage is transmittable by itself, independently of any SandVerbMessage form. This is used for messages which carry their own action context (for example AuthWrapper or Ping).

persist:

Declares that the generated SandStructMessage is persistent. The message will have the persistence fields added to it, and an instance may be sent to the DataManager for storage. A persistent message can be uniquely identified by its ID. Note that a persistent message cannot aggregate other messages directly, it can only aggregate references. See FieldTagRef for details.

authuser:

Declares that the generated SandStructMessage supports the AuthUser interface. This essentially requires that the "username" and "password" fields are present in the struct declaration, either directly or by inheritance.

tree:

Declares that the generated SandStructMessage is a visual summary message that is always displayed as a tree. Essentially the single instance display is replaced by a display of the given instance summary and all children recursively.

Field Summary

static java.lang.String	CORENAME The core name of this tag.
protected boolean	structAbstract Flag for abstract
protected boolean	structAuthuser Flag for authuser
protected boolean	structPersist Flag for persist
protected boolean	structTransmit Flag for transmit.
protected boolean	structTree Flag for tree
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

StructTagStructmessage()

Method Summary

boolean	canTransmit() accessor for structTransmit
static boolean	exists(com.sun.javadoc.ClassDoc fd) Returns true if the given field contains this tag, false otherwise.
java.lang.String	getName() Return our tag name
static StructTagStructmessage	getStructTagStructmessage(com.sun.javadoc.ClassDoc cd) Factory method for retrieving a new instance given a ClassDoc.
boolean	implementsAuthUser() accessor for structAuthuser
void	init(com.sun.javadoc.Tag tag) Initialize this instance from the tag information.
boolean	isAbstract() accessor for structAbstract
boolean	isPersistent() accessor for structPersist
boolean	isTree() accessor for structTree
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	setAbstract(boolean val) mutator for structAbstract
void	setAuthUser(boolean val) mutator for structAuthuser
void	setPersist(boolean val) mutator for structPersist
void	setTransmit(boolean val) mutator for structTransmit
void	setTree(boolean val) mutator for structTree
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 the documentation text for when several of these tags are present

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

structAbstract

protected boolean structAbstract

Flag for abstract

structTransmit

protected boolean structTransmit

Flag for transmit.

structPersist

protected boolean structPersist

Flag for persist

structAuthuser

protected boolean structAuthuser

Flag for authuser

structTree

protected boolean structTree

Flag for tree

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

StructTagStructmessage

public StructTagStructmessage()

Method Detail

isAbstract

public boolean isAbstract()

accessor for structAbstract

setAbstract

public void setAbstract(boolean val)

mutator for structAbstract

canTransmit

public boolean canTransmit()

accessor for structTransmit

setTransmit

public void setTransmit(boolean val)

mutator for structTransmit

isPersistent

public boolean isPersistent()

accessor for structPersist

setPersist

public void setPersist(boolean val)

mutator for structPersist

implementsAuthUser

public boolean implementsAuthUser()

accessor for structAuthuser

setAuthUser

public void setAuthUser(boolean val)

mutator for structAuthuser

isTree

public boolean isTree()

accessor for structTree

setTree

public void setTree(boolean val)

mutator for structTree

init

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

Initialize this instance from the tag information.

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.

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 the documentation text for when several of these tags are present

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.

getStructTagStructmessage

public static StructTagStructmessage getStructTagStructmessage(com.sun.javadoc.ClassDoc cd)

Factory method for retrieving a new instance given a ClassDoc. Returns an initialized instance in all cases.

exists

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

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