Java example source code file (BaseExecutableMemberTaglet.java)

This example Java source code file (BaseExecutableMemberTaglet.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

baseexecutablemembertaglet, basetaglet

The BaseExecutableMemberTaglet.java Java example source code

/*
 * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.tools.doclets.internal.toolkit.taglets;

/**
 * An abstract class for that implements the {@link Taglet} interface
 * for tags in <code>ExecutableMembers.
 *
 *  <p>This is NOT part of any supported API.
 *  If you write code that depends on this, you do so at your own risk.
 *  This code and its internal interfaces are subject to change or
 *  deletion without notice.</b>
 *
 * @author Jamie Ho
 * @since 1.4
 */
public abstract class BaseExecutableMemberTaglet extends BaseTaglet {

    /**
     * Return true if this <code>Taglet
     * is used in field documentation.
     * @return true if this <code>Taglet
     * is used in field documentation and false
     * otherwise.
     */
    public boolean inField() {
        return false;
    }

    /**
     * Return true if this <code>Taglet
     * is used in overview documentation.
     * @return true if this <code>Taglet
     * is used in overview documentation and false
     * otherwise.
     */
    public boolean inOverview() {
        return false;
    }

    /**
     * Return true if this <code>Taglet
     * is used in package documentation.
     * @return true if this <code>Taglet
     * is used in package documentation and false
     * otherwise.
     */
    public boolean inPackage() {
        return false;
    }

    /**
     * Return true if this <code>Taglet
     * is used in type documentation (classes or interfaces).
     * @return true if this <code>Taglet
     * is used in type documentation and false
     * otherwise.
     */
    public boolean inType() {
        return false;
    }

    /**
     * Return true if this <code>Taglet
     * is an inline tag.
     * @return true if this <code>Taglet
     * is an inline tag and false otherwise.
     */
    public boolean isInlineTag() {
        return false;
    }
}