de.smartics.exceptions.report.utils
Class InlineJavadocTags

java.lang.Object
  de.smartics.exceptions.report.utils.InlineJavadocTags

All Implemented Interfaces:

Iterable<com.thoughtworks.qdox.model.DocletTag>

public final class InlineJavadocTags
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Iterable<com.thoughtworks.qdox.model.DocletTag>
     
     

Parses the Javadoc body and returns the tags and text fragments as an iterator.

Field Summary

static String

TEXT_DOCLET_NAME The identifier of doclets that only contain text.

Constructor Summary

InlineJavadocTags(com.thoughtworks.qdox.model.JavaAnnotatedElement element)
Default constructor.

Method Summary

static boolean	isText(com.thoughtworks.qdox.model.DocletTag tag) Checks if the given tag is a simple text element.
Iterator<com.thoughtworks.qdox.model.DocletTag>	iterator() Parses the Javadoc body and returns the tags and text fragments as an iterator.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_DOCLET_NAME

public static final String TEXT_DOCLET_NAME

The identifier of doclets that only contain text.

Constant Field Value:

"{text}"

Constructor Detail

InlineJavadocTags

public InlineJavadocTags(com.thoughtworks.qdox.model.JavaAnnotatedElement element)
                  throws NullPointerException

Default constructor.

Parameters:

element - the annotated element whose Javadoc comment is to be parsed.

Throws:

NullPointerException - if element is null.

Method Detail

iterator

public Iterator<com.thoughtworks.qdox.model.DocletTag> iterator()

Parses the Javadoc body and returns the tags and text fragments as an iterator.

Specified by:

iterator in interface Iterable<com.thoughtworks.qdox.model.DocletTag>

Returns:

the iterator over doclet tags and javadoc text.

isText

public static boolean isText(com.thoughtworks.qdox.model.DocletTag tag)
                      throws NullPointerException

Checks if the given tag is a simple text element.

Parameters:

tag - the tag to test.

Returns:

true if the tag is only a text, false if it is a doclet tag.

Throws:

NullPointerException - if tag is null.