| /* |
| * Copyright (c) 2001, 2018, 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 jdk.javadoc.internal.doclets.toolkit.taglets; |
| |
| import java.util.EnumSet; |
| import javax.lang.model.element.Element; |
| |
| import com.sun.source.doctree.DocTree; |
| import jdk.javadoc.internal.doclets.toolkit.Content; |
| |
| /** |
| * An abstract class that implements the {@link Taglet} interface and |
| * serves as a base for JavaFX property getter and setter taglets. |
| * |
| * <p><b>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> |
| * |
| */ |
| public abstract class BasePropertyTaglet extends BaseTaglet { |
| |
| public BasePropertyTaglet(String name) { |
| super(name, false, EnumSet.of(Site.METHOD)); |
| } |
| |
| /** |
| * This method returns the text to be put in the resulting javadoc before |
| * the property name. |
| * |
| * @param tagletWriter the taglet writer for output |
| * @return the string to be put in the resulting javadoc. |
| */ |
| abstract String getText(TagletWriter tagletWriter); |
| |
| /** |
| * Given the <code>Tag</code> representation of this custom |
| * tag, return its string representation, which is output |
| * to the generated page. |
| * @param element |
| * @param tag the <code>Tag</code> representation of this custom tag. |
| * @param tagletWriter the taglet writer for output. |
| * @return the TagletOutput representation of this <code>Tag</code>. |
| */ |
| public Content getTagletOutput(Element element, DocTree tag, TagletWriter tagletWriter) { |
| return tagletWriter.propertyTagOutput(element, tag, getText(tagletWriter)); |
| } |
| } |