net.sf.jelly.apt.decorations
Class JavaDoc

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<java.lang.String,JavaDoc.JavaDocTagList>
          net.sf.jelly.apt.decorations.JavaDoc

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,JavaDoc.JavaDocTagList>

public class JavaDoc
extends java.util.HashMap<java.lang.String,JavaDoc.JavaDocTagList>

Object encapsulating the javadocs of a declaration. This class is intended to provide more flexibility for accessing the docs than is provided with the Declaration.getDocComment(). It is implemented as a Map from each javadoc tag to its list of values (as one javadoc tag can appear more than once in a doc comment).

Author:

Ryan Heaton

See Also:

Serialized Form

Nested Class Summary

static class

JavaDoc.JavaDocTagList A list of values for a javadoc tag.

Constructor Summary

JavaDoc()

JavaDoc(java.lang.String docComment)

Method Summary

void	setValue(java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JavaDoc

public JavaDoc()

JavaDoc

public JavaDoc(java.lang.String docComment)

Method Detail

setValue

public void setValue(java.lang.String value)

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractMap<java.lang.String,JavaDoc.JavaDocTagList>