org.jboss.forge.roaster.model.source

Interface JavaDocSource<O>

All Superinterfaces:

Internal, JavaDoc<O>, Origin<O>

public interface JavaDocSource<O>
extends JavaDoc<O>

Represents a JavaDoc entry of a JavaType.

Author:

George Gastaldi

Method Summary

Methods

Modifier and Type	Method and Description
JavaDocSource<O>	addTagValue(JavaDocTag tag) Add a tag value given an existing JavaDocTag
JavaDocSource<O>	addTagValue(String tagName, String tagValue) Add a tag value for this JavaDocSource
JavaDocSource<O>	removeAllTags() Remove all tags
JavaDocSource<O>	removeTag(JavaDocTag tag) Removes the given JavaDocTag
JavaDocSource<O>	removeTags(String tagName) Removes the given tagName from this JavaDoc
JavaDocSource<O>	setFullText(String text) Sets the whole JavaDoc text, including tags
JavaDocSource<O>	setText(String text) Sets the text for this JavaDoc (without any tags)

Methods inherited from interface org.jboss.forge.roaster.model.JavaDoc

getFullText, getTagNames, getTags, getTags, getText

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

getInternal

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

getOrigin

Method Detail

setFullText

JavaDocSource<O> setFullText(String text)

Sets the whole JavaDoc text, including tags

setText

JavaDocSource<O> setText(String text)

Sets the text for this JavaDoc (without any tags)

addTagValue

JavaDocSource<O> addTagValue(String tagName,
                           String tagValue)

Add a tag value for this JavaDocSource

addTagValue

JavaDocSource<O> addTagValue(JavaDocTag tag)

Add a tag value given an existing JavaDocTag

removeTags

JavaDocSource<O> removeTags(String tagName)

Removes the given tagName from this JavaDoc

removeTag

JavaDocSource<O> removeTag(JavaDocTag tag)

Removes the given JavaDocTag

removeAllTags

JavaDocSource<O> removeAllTags()

Remove all tags