|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxjavadoc.XDoc
Represents documentation
Field Summary | |
static int |
instanceCount
|
Constructor Summary | |
XDoc(Token javadocToken,
XProgramElement owner,
XTagFactory tagFactory)
Describe what the XDoc constructor does |
Method Summary | |
void |
addDocListener(XDocListener docListener)
Add doc listener interested in changes. |
XTag |
addTag(String tagName,
String text)
Add a tag to the doc item. |
static String |
dotted(String tagName)
Convert a tag name from the old colon-separated form to the new preferred dot-separated form. |
String |
getCommentText()
return description of program element |
String |
getFirstSentence()
Return the first sentence of the text of the comment for this doc item. |
XProgramElement |
getOwner()
Gets the Owner attribute of the XDoc object |
XTag |
getTag(String tagName)
Get the first tag of name tagName from this doc. |
XTag |
getTag(String tagName,
boolean superclasses)
Get the first tag of name tagName. |
String |
getTagAttributeValue(String tagName,
String attributeName)
Returns the tag attribute value. |
String |
getTagAttributeValue(String tagName,
String attributeName,
boolean superclasses)
Returns the tag attribute value. |
List |
getTags()
Returns all the tags in this doc (not superclasses). |
List |
getTags(boolean superclasses)
Returns all the tags. |
List |
getTags(String tagName)
Returns all the tags in this doc with the specified tagName (not superclasses). |
List |
getTags(String tagName,
boolean superclasses)
Returns all the tags with the specified tagName. |
boolean |
hasTag(String tagName)
Returns true if the tag exists. |
boolean |
hasTag(String tagName,
boolean superclasses)
Returns true if the tag exists. |
void |
removeDocListener(XDocListener docListener)
remove doc listener |
boolean |
removeTag(XTag tag)
Removes tag. |
void |
setCommentText(String commentText)
Set the text of the comment for this doc item. |
void |
tagChanged(XTagEvent event)
receive change notification from xtag |
String |
toString()
Returns a String representation of this doc. |
XTag |
updateTagValue(String tagName,
String attributeName,
String attributeValue,
int tagIndex)
Utility method to set the value of a tag attribute. |
void |
updateToken()
update token |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static int instanceCount
Constructor Detail |
public XDoc(Token javadocToken, XProgramElement owner, XTagFactory tagFactory)
javadocToken
- Describe what the parameter doesowner
- Describe what the parameter doestagFactory
- Describe what the parameter doesMethod Detail |
public static String dotted(String tagName)
tagName
- The name of the tag
public XProgramElement getOwner()
public List getTags(String tagName)
tagName
- the name of the tags to return (without the 'at')
public List getTags(String tagName, boolean superclasses)
tagName
- the name of the tags to return (without the 'at')superclasses
- if this is true, return tags from superclasses too.
public List getTags()
public List getTags(boolean superclasses)
superclasses
- if this is true, return tags from superclasses too.
public XTag getTag(String tagName)
tagName
- the name of the tag
public XTag getTag(String tagName, boolean superclasses)
tagName
- the name of the tag to get (without the 'at')superclasses
- if this is true, return tags from superclasses too.
public String getTagAttributeValue(String tagName, String attributeName)
tagName
- The name of the tag to look for (without the 'at')attributeName
- The name of the attribute to look for within the tag.
public String getTagAttributeValue(String tagName, String attributeName, boolean superclasses)
tagName
- The name of the tag to look for (without the 'at')attributeName
- The name of the attribute to look for within the tag.superclasses
- Set it to true to look in superclasses too.
public String getCommentText()
public String getFirstSentence()
public void setCommentText(String commentText)
commentText
- The new comment textpublic boolean hasTag(String tagName)
tagName
- The name of the tag to look for (without the 'at')
public boolean hasTag(String tagName, boolean superclasses)
tagName
- The name of the tag to look for (without the 'at')superclasses
- If true, look in superclasses too.
public XTag updateTagValue(String tagName, String attributeName, String attributeValue, int tagIndex) throws XJavaDocException
tagName
- The new name of the tag to update (without thetagIndex
- The index of the tag to update, in case there
are several tags with the same name.attributeName
- The attribute nameattributeValue
- The new attribute value
XJavaDocException
public void addDocListener(XDocListener docListener)
docListener
- doc listener to registerpublic void removeDocListener(XDocListener docListener)
docListener
- public String toString()
public void updateToken()
public boolean removeTag(XTag tag)
tag
- tag to be removed
public XTag addTag(String tagName, String text)
tagName
- The name of the tag to addtext
- The value of the tag
TagValidationException
- if validation is activated (in XTagFactory)
and tagName is not among the registered tags.public void tagChanged(XTagEvent event)
tagChanged
in interface XTagListener
event
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |