CDKBugTaglet.java

/* $Revision$ $Author$ $Date$
 * 
 * Copyright (C) 2004-2007  Egon Willighagen <egonw@users.sf.net>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
package net.sf.cdk.tools.doclets;

import com.sun.tools.doclets.Taglet;
import com.sun.javadoc.*;
import java.util.Map;

/**
 * Taglet that expands @cdk.bug tag into a weblink to CDK's
 * SourceForge bug track system. It's typically used as:
 * <pre>
 *   @cdk.bug 1095690
 * </pre>
 */
public class CDKBugTaglet implements Taglet {
    
    private static final String NAME = "cdk.bug";
    
    public String getName() {
        return NAME;
    }
    
    public boolean inField() {
        return false;
    }

    public boolean inConstructor() {
        return false;
    }
    
    public boolean inMethod() {
        return false;
    }
    
    public boolean inOverview() {
        return false;
    }

    public boolean inPackage() {
        return false;
    }

    public boolean inType() {
        return true;
    }
    
    public boolean isInlineTag() {
        return false;
    }
    
    public static void register(Map<String, CDKBugTaglet> tagletMap) {
       CDKBugTaglet tag = new CDKBugTaglet();
       Taglet t = (Taglet) tagletMap.get(tag.getName());
       if (t != null) {
           tagletMap.remove(tag.getName());
       }
       tagletMap.put(tag.getName(), tag);
    }

    public String toString(Tag tag) {
        return "<DT><B>This class is affected by these bug(s): </B><DD>"
               + expand(tag) + "</DD>\n";
    }
    
    public String toString(Tag[] tags) {
        if (tags.length == 0) {
            return null;
        } else {
        	StringBuffer list = new StringBuffer();
        	list.append("<DT><B>This class is affected by these bug(s): </B><DD>");
        	for (int i=0; i<tags.length; i++) {
        		list.append(expand(tags[i])).append(" ");
        	}
        	list.append("</DD>\n");
            return list.toString();
        }
    }

    private String expand(Tag tag) {
    	String tagText = tag.text(); 
    	if (Integer.valueOf(tagText) > 100000) {
    		return "<a href=\"http://sourceforge.net/tracker/index.php?func=detail&group_id=20024&atid=120024&aid="
    				+ tagText + "\">" + tagText + "</a>";
    	} else {
    		return "<a href=\"https://sourceforge.net/p/cdk/bugs/" + tagText + "/\">" + tagText + "</a>";
    	}
    }
}