attrib4j.attributes
Class JavadocAttribute

java.lang.Object
  |
  +--attrib4j.attributes.JavadocAttribute

All Implemented Interfaces:

Attribute, java.io.Serializable

public class JavadocAttribute

extends java.lang.Object

implements Attribute

See Also:

Serialized Form

Constructor Summary

JavadocAttribute(java.lang.String name, java.lang.String text)
Create a JavadocAttribute with the tag and text of the Javadoc comment.

Method Summary

java.lang.String	getName() Get the name of the Javadoc tag.
java.lang.String	getText() Return the text of this tag, that is, portion beyond tag name.
java.lang.String	toString() Return a pretty print textual description of the attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocAttribute

public JavadocAttribute(java.lang.String name,
                        java.lang.String text)

Create a JavadocAttribute with the tag and text of the Javadoc comment.

Method Detail

getName

public java.lang.String getName()

Get the name of the Javadoc tag. Unlike the Doclet API this does not return the leading '@' symbol.

Returns:

the name of the Javadoc tag value.

getText

public java.lang.String getText()

Return the text of this tag, that is, portion beyond tag name.

Returns:

the text of this tag, that is, portion beyond tag name.

toString

public java.lang.String toString()

Return a pretty print textual description of the attribute.

Overrides:

toString in class java.lang.Object

Returns:

a pretty print textual description of the attribute.