public class Comments
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.util.Hashtable |
allPossibleComments
All the possible comments known about, accessible by the commentID.
|
java.util.List |
commentsList_ |
static java.lang.String |
placeHolderText
The text placed into XML comments file where there is no comment yet.
|
Constructor and Description |
---|
Comments()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addComment(jdiff.SingleComment comment)
Add the SingleComment object to the list of comments kept by this
object.
|
static java.lang.String |
convertAtLinks(java.lang.String text,
java.lang.String currentElement,
jdiff.PackageAPI pkg,
jdiff.ClassAPI cls)
Convert @link tags to HTML links.
|
void |
dump()
Dump the contents of a Comments object out for inspection.
|
void |
emitComments()
Write the Comments object out in XML.
|
void |
emitXMLFooter()
Emit the XML footer.
|
void |
emitXMLHeader(java.lang.String filename)
Emit the XML header.
|
static java.lang.String |
getComment(Comments comments,
java.lang.String id)
Return the comment associated with the given id in the Comment object.
|
static boolean |
isMinimizedTag(java.lang.String tag)
Return true if the given HTML tag has no separate end element.
|
static void |
noteDifferences(Comments oldComments,
Comments newComments)
Emit messages about which comments are now unused and which are new.
|
static Comments |
readFile(java.lang.String filename)
Read the file where the XML for comments about the changes between
the old API and new API is stored and create a Comments object for
it.
|
static boolean |
writeFile(java.lang.String outputFileName,
Comments newComments)
Write the XML representation of comments to a file.
|
static void |
writeXSD(java.lang.String filename)
Write the XML Schema file used for validation.
|
public static java.util.Hashtable allPossibleComments
public java.util.List commentsList_
public static final java.lang.String placeHolderText
public static Comments readFile(java.lang.String filename)
public static void writeXSD(java.lang.String filename)
public void addComment(jdiff.SingleComment comment)
public static java.lang.String getComment(Comments comments, java.lang.String id)
public static java.lang.String convertAtLinks(java.lang.String text, java.lang.String currentElement, jdiff.PackageAPI pkg, jdiff.ClassAPI cls)
public static boolean writeFile(java.lang.String outputFileName, Comments newComments)
outputFileName
- The name of the comments file.oldComments
- The old comments on the changed APIs.newComments
- The new comments on the changed APIs.public void emitComments()
public void dump()
public static void noteDifferences(Comments oldComments, Comments newComments)
public void emitXMLHeader(java.lang.String filename)
public void emitXMLFooter()
public static boolean isMinimizedTag(java.lang.String tag)