BasePropertyTaglet.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2001, 2015, 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
26package jdk.javadoc.internal.doclets.toolkit.taglets;
27
28import javax.lang.model.element.Element;
29
30import com.sun.source.doctree.DocTree;
31import jdk.javadoc.internal.doclets.toolkit.Content;
32
33/**
34 * An abstract class that implements the {@link Taglet} interface and
35 * serves as a base for JavaFX property getter and setter taglets.
36 *
37 *  <p><b>This is NOT part of any supported API.
38 *  If you write code that depends on this, you do so at your own risk.
39 *  This code and its internal interfaces are subject to change or
40 *  deletion without notice.</b>
41 *
42 */
43public abstract class BasePropertyTaglet extends BaseTaglet {
44
45    public BasePropertyTaglet() {
46    }
47
48    /**
49     * This method returns the text to be put in the resulting javadoc before
50     * the property name.
51     *
52     * @param tagletWriter the taglet writer for output
53     * @return the string to be put in the resulting javadoc.
54     */
55    abstract String getText(TagletWriter tagletWriter);
56
57    /**
58     * Given the <code>Tag</code> representation of this custom
59     * tag, return its string representation, which is output
60     * to the generated page.
61     * @param element
62     * @param tag the <code>Tag</code> representation of this custom tag.
63     * @param tagletWriter the taglet writer for output.
64     * @return the TagletOutput representation of this <code>Tag</code>.
65     */
66    public Content getTagletOutput(Element element, DocTree tag, TagletWriter tagletWriter) {
67        return tagletWriter.propertyTagOutput(element, tag, getText(tagletWriter));
68    }
69
70    /**
71     * Will return false because this tag may
72     * only appear in Methods.
73     * @return false since this is not a method.
74     */
75    public boolean inConstructor() {
76        return false;
77    }
78
79    /**
80     * Will return false because this tag may
81     * only appear in Methods.
82     * @return false since this is not a method.
83     */
84    public boolean inOverview() {
85        return false;
86    }
87
88    /**
89     * Will return false because this tag may
90     * only appear in Methods.
91     * @return false since this is not a method.
92     */
93    public boolean inPackage() {
94        return false;
95    }
96
97    /**
98     * Will return false because this tag may
99     * only appear in Methods.
100     * @return false since this is not a method.
101     */
102    public boolean inType() {
103        return false;
104    }
105
106    /**
107     * Will return false because this tag is not inline.
108     * @return false since this is not an inline tag.
109     */
110    public boolean isInlineTag() {
111        return false;
112    }
113
114}
115