org.sandev.generator
Class SandTag

java.lang.Object
  org.sandev.generator.SandTag

All Implemented Interfaces:

com.sun.javadoc.Tag

public class SandTag
extends java.lang.Object
implements com.sun.javadoc.Tag

Just enough Tag interface implementation for us to squeeze some generator functionality into a SandFieldDoc instance.

Field Summary

protected java.lang.String	tagName the name of this tag, for example "@enumint"
protected java.lang.String	tagText the text of this tag, aka everything after the name

Constructor Summary

SandTag(java.lang.String name, java.lang.String text)

Method Summary

com.sun.javadoc.Tag[]	firstSentenceTags() stubbed
java.lang.String	getTagName() accessor for tagName
java.lang.String	getTagText() accessor for tagText
com.sun.javadoc.Doc	holder() Not implemented, returns null
com.sun.javadoc.Tag[]	inlineTags() stubbed
java.lang.String	kind() always returns "generated"
java.lang.String	name() wraps getTagName()
com.sun.javadoc.SourcePosition	position() stubbed
void	setTagName(java.lang.String name) mutator for tagName
void	setTagText(java.lang.String text) mutator for tagText
java.lang.String	text() wraps getTagText()
java.lang.String	toString() whatever

Methods inherited from class java.lang.Object

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

Field Detail

tagName

protected java.lang.String tagName

the name of this tag, for example "@enumint"

tagText

protected java.lang.String tagText

the text of this tag, aka everything after the name

Constructor Detail

SandTag

public SandTag(java.lang.String name,
               java.lang.String text)

Method Detail

getTagName

public java.lang.String getTagName()

accessor for tagName

setTagName

public void setTagName(java.lang.String name)

mutator for tagName

getTagText

public java.lang.String getTagText()

accessor for tagText

setTagText

public void setTagText(java.lang.String text)

mutator for tagText

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

stubbed

Specified by:

firstSentenceTags in interface com.sun.javadoc.Tag

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

stubbed

Specified by:

inlineTags in interface com.sun.javadoc.Tag

kind

public java.lang.String kind()

always returns "generated"

Specified by:

kind in interface com.sun.javadoc.Tag

name

public java.lang.String name()

wraps getTagName()

Specified by:

name in interface com.sun.javadoc.Tag

position

public com.sun.javadoc.SourcePosition position()

stubbed

Specified by:

position in interface com.sun.javadoc.Tag

text

public java.lang.String text()

wraps getTagText()

Specified by:

text in interface com.sun.javadoc.Tag

holder

public com.sun.javadoc.Doc holder()

Not implemented, returns null

Specified by:

holder in interface com.sun.javadoc.Tag

toString

public java.lang.String toString()

whatever

Specified by:

toString in interface com.sun.javadoc.Tag

Overrides:

toString in class java.lang.Object