1 /*
   2  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.doclets.internal.toolkit.taglets;
  27 
  28 /**
  29  * An abstract class for that implements the {@link Taglet} interface
  30  * for tags in <code>ExecutableMembers</code>.
  31  *
  32  *  <p><b>This is NOT part of any supported API.
  33  *  If you write code that depends on this, you do so at your own risk.
  34  *  This code and its internal interfaces are subject to change or
  35  *  deletion without notice.</b>
  36  *
  37  * @author Jamie Ho
  38  * @since 1.4
  39  */
  40 public abstract class BaseExecutableMemberTaglet extends BaseTaglet {
  41 
  42     /**
  43      * Return true if this <code>Taglet</code>
  44      * is used in field documentation.
  45      * @return true if this <code>Taglet</code>
  46      * is used in field documentation and false
  47      * otherwise.
  48      */
  49     public boolean inField() {
  50         return false;
  51     }
  52 
  53     /**
  54      * Return true if this <code>Taglet</code>
  55      * is used in overview documentation.
  56      * @return true if this <code>Taglet</code>
  57      * is used in overview documentation and false
  58      * otherwise.
  59      */
  60     public boolean inOverview() {
  61         return false;
  62     }
  63 
  64     /**
  65      * Return true if this <code>Taglet</code>
  66      * is used in package documentation.
  67      * @return true if this <code>Taglet</code>
  68      * is used in package documentation and false
  69      * otherwise.
  70      */
  71     public boolean inPackage() {
  72         return false;
  73     }
  74 
  75     /**
  76      * Return true if this <code>Taglet</code>
  77      * is used in type documentation (classes or interfaces).
  78      * @return true if this <code>Taglet</code>
  79      * is used in type documentation and false
  80      * otherwise.
  81      */
  82     public boolean inType() {
  83         return false;
  84     }
  85 
  86     /**
  87      * Return true if this <code>Taglet</code>
  88      * is an inline tag.
  89      * @return true if this <code>Taglet</code>
  90      * is an inline tag and false otherwise.
  91      */
  92     public boolean isInlineTag() {
  93         return false;
  94     }
  95 }