Package org.jboss.forge.roaster.model

Interface JavaDoc<O>

All Superinterfaces:

Internal, Origin<O>

All Known Subinterfaces:

JavaDocSource<O>

public interface JavaDoc<O>
extends Internal, Origin<O>

A JavaDoc represents Javadoc-style doc comment

Author:

George Gastaldi

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFullText()	Returns the full text for this JavaDoc, including tags
java.util.Set<java.lang.String>	getTagNames()	Return the tag names for this JavaDoc
java.util.List<JavaDocTag>	getTags()	Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found
java.util.List<JavaDocTag>	getTags(java.lang.String tagName)	Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found
java.lang.String	getText()	Returns the text for this JavaDoc, excluding tags

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Method Detail

getText

java.lang.String getText()

Returns the text for this JavaDoc, excluding tags

getFullText

java.lang.String getFullText()

Returns the full text for this JavaDoc, including tags

getTagNames

java.util.Set<java.lang.String> getTagNames()

Return the tag names for this JavaDoc

getTags

java.util.List<JavaDocTag> getTags(java.lang.String tagName)

Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found

getTags

java.util.List<JavaDocTag> getTags()

Returns a list of JavaDocTag values for the given tag name (eg: @param) or an empty list if not found