libjava/classpath/tools/gnu/classpath/tools/doclets/StandardTaglet.java

   1 /* gnu.classpath.tools.doclets.StandardTaglet
   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 package gnu.classpath.tools.doclets;
  22
  23 import com.sun.javadoc.Tag;
  24 import com.sun.tools.doclets.Taglet;
  25
  26 /**
  27  *  Represents one of the built-in taglets. Used for specifying taglet
  28  *  order.
  29  */
  30 public class StandardTaglet
  31    implements Taglet
  32 {
  33    private String name;
  34
  35    /**
  36     *  Initialize with one of the built-in taglet names.
  37     */
  38    public StandardTaglet(String name) {
  39       this.name = name;
  40    }
  41
  42    public boolean inField() {
  43       return true;
  44    }
  45
  46    public boolean inConstructor() {
  47       return true;
  48    }
  49
  50    public boolean inMethod() {
  51       return true;
  52    }
  53
  54    public boolean inOverview() {
  55       return true;
  56    }
  57
  58    public boolean inPackage() {
  59       return true;
  60    }
  61
  62    public boolean inType() {
  63       return true;
  64    }
  65
  66    public boolean isInlineTag() {
  67       return false;
  68    }
  69
  70    public String getName() {
  71       return this.name;
  72    }
  73
  74    public String toString(Tag tag) {
  75       //assert(false);
  76       return null;
  77    }
  78
  79    public String toString(Tag[] tags) {
  80       //assert(false);
  81       return null;
  82    }
  83 }