libjava/classpath/tools/gnu/classpath/tools/taglets/DeprecatedTaglet.java

   1 /* gnu.classpath.tools.taglets.DeprecatedTaglet
   2    Copyright (C) 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA. */
  20
  21 package gnu.classpath.tools.taglets;
  22
  23 import java.util.Map;
  24
  25 import com.sun.tools.doclets.Taglet;
  26
  27 import com.sun.javadoc.Tag;
  28
  29 /**
  30  *  The default Taglet which handles deprecated information.
  31  *
  32  *  @author Julian Scheid (julian@sektor37.de)
  33  */
  34 public class DeprecatedTaglet implements Taglet {
  35
  36    private static final String NAME = "deprecated";
  37    private static final String HEADER = "Deprecated:";
  38
  39    private static boolean enabled = true;
  40
  41    public String getName() {
  42       return NAME;
  43    }
  44
  45    public boolean inField() {
  46       return true;
  47    }
  48
  49    public boolean inConstructor() {
  50       return true;
  51    }
  52
  53    public boolean inMethod() {
  54       return true;
  55    }
  56
  57    public boolean inOverview() {
  58       return true;
  59    }
  60
  61    public boolean inPackage() {
  62       return true;
  63    }
  64
  65    public boolean inType() {
  66       return true;
  67    }
  68
  69    public boolean isInlineTag() {
  70       return false;
  71    }
  72
  73    public static void register(Map tagletMap) {
  74       DeprecatedTaglet deprecatedTaglet = new DeprecatedTaglet();
  75       tagletMap.put(deprecatedTaglet.getName(), deprecatedTaglet);
  76    }
  77
  78    public String toString(Tag tag) {
  79       if (enabled) {
  80          return toString(new Tag[] { tag });
  81       }
  82       else {
  83          return null;
  84       }
  85    }
  86
  87    public String toString(Tag[] tags) {
  88       if (!enabled || tags.length == 0) {
  89          return null;
  90       }
  91       else {
  92
  93          StringBuffer result = new StringBuffer();
  94          result.append("<div class=\"classdoc-tag-section-header\">");
  95          result.append(HEADER);
  96          result.append("</div>");
  97          result.append("<dl class=\"classdoc-list\">");
  98          for (int i = 0; i < tags.length; i++) {
  99             result.append("<dt>");
 100             result.append(tags[i].text());
 101             result.append("</dt>");
 102          }
 103          result.append("</dl>");
 104          return result.toString();
 105       }
 106    }
 107
 108    /**
 109     *  Enables/disables this taglet.
 110     */
 111    public static void setTagletEnabled(boolean enabled)
 112    {
 113       DeprecatedTaglet.enabled = enabled;
 114    }
 115 }