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

   1 /* gnu.classpath.tools.taglets.CopyrightTaglet
   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 simple Taglet which handles Copyright information.
  31  */
  32 public class CopyrightTaglet implements Taglet {
  33
  34    private static final String NAME = "copyright";
  35    private static final String HEADER = "Copyright:";
  36
  37    public String getName() {
  38       return NAME;
  39    }
  40
  41    public boolean inField() {
  42       return true;
  43    }
  44
  45    public boolean inConstructor() {
  46       return true;
  47    }
  48
  49    public boolean inMethod() {
  50       return true;
  51    }
  52
  53    public boolean inOverview() {
  54       return true;
  55    }
  56
  57    public boolean inPackage() {
  58       return true;
  59    }
  60
  61    public boolean inType() {
  62       return true;
  63    }
  64
  65    public boolean isInlineTag() {
  66       return false;
  67    }
  68
  69    public static void register(Map tagletMap) {
  70       CopyrightTaglet copyrightTaglet = new CopyrightTaglet();
  71       tagletMap.put(copyrightTaglet.getName(), copyrightTaglet);
  72    }
  73
  74    public String toString(Tag tag) {
  75       return toString(new Tag[] { tag });
  76    }
  77
  78    public String toString(Tag[] tags) {
  79       if (tags.length == 0) {
  80          return null;
  81       }
  82       else {
  83          boolean haveValidTag = false;
  84          for (int i = 0; i < tags.length && !haveValidTag; ++i) {
  85             if (tags[i].text().length() > 0) {
  86                haveValidTag = true;
  87             }
  88          }
  89
  90          if (haveValidTag) {
  91             StringBuffer result = new StringBuffer();
  92             result.append("<dl>");
  93             for (int i = 0; i < tags.length; i++) {
  94                if (tags[i].text().length() > 0) {
  95                   result.append("<dt><i>Copyright &#169; " + tags[i].text() + "</i></dt>");
  96                }
  97             }
  98             result.append("</dl>");
  99             return result.toString();
 100          }
 101          else {
 102             return null;
 103          }
 104       }
 105    }
 106 }