spoon.javadoc.internal

Class JavadocInlineTag

java.lang.Object

spoon.javadoc.internal.JavadocInlineTag

All Implemented Interfaces:

java.io.Serializable, JavadocDescriptionElement

public class JavadocInlineTag
extends java.lang.Object
implements JavadocDescriptionElement, java.io.Serializable

An inline tag contained in a Javadoc description.

For example String

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavadocInlineTag.Type The type of tag: it could either correspond to a known tag (code, docRoot, etc.) or represent an unknown tag.

Constructor Summary

Constructors

Constructor and Description
JavadocInlineTag(java.lang.String tagName, JavadocInlineTag.Type type, java.lang.String content)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static JavadocDescriptionElement	fromText(java.lang.String text) parses a Javadoc tag
java.lang.String	getContent()
java.lang.String	getName()
JavadocInlineTag.Type	getType()
int	hashCode()
static java.lang.String	nextWord(java.lang.String string) Return the next word of the string, in other words it stops when a space is encountered.
void	setContent(java.lang.String content)
java.lang.String	toString()
java.lang.String	toText() pretty-prints the Javadoc fragment

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocInlineTag

public JavadocInlineTag(java.lang.String tagName,
                        JavadocInlineTag.Type type,
                        java.lang.String content)

Method Detail

nextWord

public static java.lang.String nextWord(java.lang.String string)

Return the next word of the string, in other words it stops when a space is encountered.

fromText

public static JavadocDescriptionElement fromText(java.lang.String text)

parses a Javadoc tag

setContent

public void setContent(java.lang.String content)

getType

public JavadocInlineTag.Type getType()

getContent

public java.lang.String getContent()

getName

public java.lang.String getName()

toText

public java.lang.String toText()

Description copied from interface: JavadocDescriptionElement

pretty-prints the Javadoc fragment

Specified by:

toText in interface JavadocDescriptionElement

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object