| "; private static final String HTML_END = " |
BBToDoTaglet
* can be used in field documentation.
* @return true since this BBToDoTaglet
* can be used in field documentation and false
* otherwise.
*/
public boolean inField() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return true since this BBToDoTaglet
* can be used in constructor documentation.
* @return true since this BBToDoTaglet
* can be used in constructor documentation and false
* otherwise.
*/
public boolean inConstructor() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return true since this BBToDoTaglet
* can be used in method documentation.
* @return true since this BBToDoTaglet
* can be used in method documentation and false
* otherwise.
*/
public boolean inMethod() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return true since this BBToDoTaglet
* can be used in method documentation.
* @return true since this BBToDoTaglet
* can be used in overview documentation and false
* otherwise.
*/
public boolean inOverview() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return true since this BBToDoTaglet
* can be used in package documentation.
* @return true since this BBToDoTaglet
* can be used in package documentation and false
* otherwise.
*/
public boolean inPackage() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return true since this BBToDoTaglet
* can be used in type documentation (classes or interfaces).
* @return true since this BBToDoTaglet
* can be used in type documentation and false
* otherwise.
*/
public boolean inType() {
return true;
}
////////////////////////////////////////////////////////////////////////////
/**
* Will return false since this BBToDoTaglet
* is not an inline tag.
* @return false since this BBToDoTaglet
* is not an inline tag.
*/
public boolean isInlineTag() {
return false;
}
////////////////////////////////////////////////////////////////////////////
/**
* Register this Taglet.
* @param tagletMap the map to register this tag to.
*/
public static void register(Map tagletMap) {
BBToDoTaglet tag = new BBToDoTaglet();
Taglet t = (Taglet) tagletMap.get(tag.getName());
if (t != null) {
tagletMap.remove(tag.getName());
}
tagletMap.put(tag.getName(), tag);
}
////////////////////////////////////////////////////////////////////////////
/**
* Given the Tag representation of this custom
* tag, return its string representation.
* @param tag he Tag representation of this custom tag.
*/
public String toString(Tag tag) {
return HTML_START + tag.text() + HTML_END;
}
////////////////////////////////////////////////////////////////////////////
/**
* Given an array of Tags representing this custom
* tag, return its string representation.
* @param tags the array of Tags representing of this custom tag.
*/
public String toString(Tag[] tags) {
if (tags.length == 0) {
return null;
}
StringBuffer result = new StringBuffer(HTML_START);
for (int i = 0; i < tags.length; i++) {
if (i > 0) {
result.append(", ");
}
result.append(tags[i].text());
}
result.append(HTML_END);
return result.toString();
}
}