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

   1 /* gnu.classpath.tools.taglets.GenericTaglet
   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  *  A taglet which can be configured at runtime.
  31  *
  32  *  @author Julian Scheid (julian@sektor37.de)
  33  */
  34 public class GenericTaglet implements Taglet {
  35
  36    private String name = "since";
  37    private String header = "Since:";
  38
  39    private boolean scopeOverview;
  40    private boolean scopePackage;
  41    private boolean scopeType;
  42    private boolean scopeConstructor;
  43    private boolean scopeMethod;
  44    private boolean scopeField;
  45
  46    private boolean enabled = true;
  47
  48    public GenericTaglet(String name,
  49                         String header,
  50                         boolean scopeOverview,
  51                         boolean scopePackage,
  52                         boolean scopeType,
  53                         boolean scopeConstructor,
  54                         boolean scopeMethod,
  55                         boolean scopeField)
  56    {
  57       this.name = name;
  58       this.header = header;
  59       this.scopeOverview = scopeOverview;
  60       this.scopePackage = scopePackage;
  61       this.scopeType = scopeType;
  62       this.scopeConstructor = scopeConstructor;
  63       this.scopeMethod = scopeMethod;
  64       this.scopeField = scopeField;
  65    }
  66
  67    public String getName() {
  68       return name;
  69    }
  70
  71    public boolean inField() {
  72       return scopeField;
  73    }
  74
  75    public boolean inConstructor() {
  76       return scopeConstructor;
  77    }
  78
  79    public boolean inMethod() {
  80       return scopeMethod;
  81    }
  82
  83    public boolean inOverview() {
  84       return scopeOverview;
  85    }
  86
  87    public boolean inPackage() {
  88       return scopePackage;
  89    }
  90
  91    public boolean inType() {
  92       return scopeType;
  93    }
  94
  95    public boolean isInlineTag() {
  96       return false;
  97    }
  98
  99    public void register(Map tagletMap) {
 100       tagletMap.put(getName(), this);
 101    }
 102
 103    public String toString(Tag tag) {
 104       if (enabled) {
 105          return toString(new Tag[] { tag });
 106       }
 107       else {
 108          return null;
 109       }
 110    }
 111
 112    public String toString(Tag[] tags) {
 113       if (!enabled || tags.length == 0) {
 114          return null;
 115       }
 116       else {
 117
 118          StringBuffer result = new StringBuffer();
 119          result.append("<div class=\"classdoc-tag-section-header\">");
 120          result.append(header);
 121          result.append("</div>");
 122          result.append("<dl class=\"classdoc-list\">");
 123          for (int i = 0; i < tags.length; i++) {
 124             result.append("<dt>");
 125             result.append(tags[i].text());
 126             result.append("</dt>");
 127          }
 128          result.append("</dl>");
 129          return result.toString();
 130       }
 131    }
 132
 133    /**
 134     *  Enables/disables this taglet.
 135     */
 136    public void setTagletEnabled(boolean enabled)
 137    {
 138       this.enabled = enabled;
 139    }
 140 }