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

   1 /* gnu.classpath.tools.taglets.ValueTaglet
   2    Copyright (C) 2004 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 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package gnu.classpath.tools.taglets;
  39
  40 import java.util.Map;
  41
  42 import com.sun.tools.doclets.Taglet;
  43
  44 import com.sun.javadoc.Doc;
  45 import com.sun.javadoc.Tag;
  46 import com.sun.javadoc.FieldDoc;
  47 import com.sun.javadoc.MemberDoc;
  48 import com.sun.javadoc.SeeTag;
  49
  50 /**
  51  *  The default Taglet which shows final static field values.
  52  *
  53  *  @author Julian Scheid (julian@sektor37.de)
  54  */
  55 public class ValueTaglet
  56    implements GnuExtendedTaglet
  57 {
  58    private static final String NAME = "value";
  59
  60    public String getName() {
  61       return NAME;
  62    }
  63
  64    public boolean inField() {
  65       return true;
  66    }
  67
  68    public boolean inConstructor() {
  69       return true;
  70    }
  71
  72    public boolean inMethod() {
  73       return true;
  74    }
  75
  76    public boolean inOverview() {
  77       return true;
  78    }
  79
  80    public boolean inPackage() {
  81       return true;
  82    }
  83
  84    public boolean inType() {
  85       return true;
  86    }
  87
  88    public boolean isInlineTag() {
  89       return true;
  90    }
  91
  92    public static void register(Map tagletMap) {
  93       ValueTaglet valueTaglet = new ValueTaglet();
  94       tagletMap.put(valueTaglet.getName(), valueTaglet);
  95    }
  96
  97    public String toString(Tag tag) {
  98       return null;
  99    }
 100
 101    public String toString(Tag tag, TagletContext context) {
 102       if (0 == tag.inlineTags().length) {
 103          if (context.getDoc().isField()) {
 104             FieldDoc fieldDoc = (FieldDoc)context.getDoc();
 105             if (fieldDoc.isStatic() && fieldDoc.isFinal()) {
 106                return fieldDoc.constantValueExpression();
 107             }
 108          }
 109       }
 110       else {
 111          MemberDoc referencedMember = ((SeeTag)tag).referencedMember();
 112          if (null != referencedMember && referencedMember.isField()) {
 113             FieldDoc fieldDoc = (FieldDoc)referencedMember;
 114             if (fieldDoc.isStatic() && fieldDoc.isFinal()) {
 115                return fieldDoc.constantValueExpression();
 116             }
 117          }
 118       }
 119       return "";
 120    }
 121
 122    public String toString(Tag[] tags) {
 123       return null;
 124    }
 125
 126    public String toString(Tag[] tags, TagletContext context) {
 127       return null;
 128    }
 129
 130 }