jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/BasePropertyTaglet.java@93012e2a5d1d

     1 /*

     2  * Copyright (c) 2001, 2013, 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  */

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

    28 import com.sun.javadoc.Tag;

    29 import com.sun.tools.doclets.internal.toolkit.Content;

    31 /**

    32  * An abstract class that implements the {@link Taglet} interface and

    33  * serves as a base for JavaFX property getter and setter taglets.

    34  *

    35  *  <p><b>This is NOT part of any supported API.

    36  *  If you write code that depends on this, you do so at your own risk.

    37  *  This code and its internal interfaces are subject to change or

    38  *  deletion without notice.</b>

    39  *

    40  */

    41 public abstract class BasePropertyTaglet extends BaseTaglet {

    43     public BasePropertyTaglet() {

    44     }

    46     /**

    47      * This method returns the text to be put in the resulting javadoc before

    48      * the property name.

    49      *

    50      * @param tagletWriter the taglet writer for output

    51      * @return the string to be put in the resulting javadoc.

    52      */

    53     abstract String getText(TagletWriter tagletWriter);

    55     /**

    56      * Given the <code>Tag</code> representation of this custom

    57      * tag, return its string representation, which is output

    58      * to the generated page.

    59      * @param tag the <code>Tag</code> representation of this custom tag.

    60      * @param tagletWriter the taglet writer for output.

    61      * @return the TagletOutput representation of this <code>Tag</code>.

    62      */

    63     public Content getTagletOutput(Tag tag, TagletWriter tagletWriter) {

    64         return tagletWriter.propertyTagOutput(tag, getText(tagletWriter));

    65     }

    67     /**

    68      * Will return false because this tag may

    69      * only appear in Methods.

    70      * @return false since this is not a method.

    71      */

    72     public boolean inConstructor() {

    73         return false;

    74     }

    76     /**

    77      * Will return false because this tag may

    78      * only appear in Methods.

    79      * @return false since this is not a method.

    80      */

    81     public boolean inOverview() {

    82         return false;

    83     }

    85     /**

    86      * Will return false because this tag may

    87      * only appear in Methods.

    88      * @return false since this is not a method.

    89      */

    90     public boolean inPackage() {

    91         return false;

    92     }

    94     /**

    95      * Will return false because this tag may

    96      * only appear in Methods.

    97      * @return false since this is not a method.

    98      */

    99     public boolean inType() {

   100         return false;

   101     }

   103     /**

   104      * Will return false because this tag is not inline.

   105      * @return false since this is not an inline tag.

   106      */

   107     public boolean isInlineTag() {

   108         return false;

   109     }

   111 }

Mercurial > jdk8-mips64-public > langtools / file revision