jjg@1606: /*
jjg@1606:  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
jjg@1606:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jjg@1606:  *
jjg@1606:  * This code is free software; you can redistribute it and/or modify it
jjg@1606:  * under the terms of the GNU General Public License version 2 only, as
jjg@1606:  * published by the Free Software Foundation.  Oracle designates this
jjg@1606:  * particular file as subject to the "Classpath" exception as provided
jjg@1606:  * by Oracle in the LICENSE file that accompanied this code.
jjg@1606:  *
jjg@1606:  * This code is distributed in the hope that it will be useful, but WITHOUT
jjg@1606:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jjg@1606:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jjg@1606:  * version 2 for more details (a copy is included in the LICENSE file that
jjg@1606:  * accompanied this code).
jjg@1606:  *
jjg@1606:  * You should have received a copy of the GNU General Public License version
jjg@1606:  * 2 along with this work; if not, write to the Free Software Foundation,
jjg@1606:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jjg@1606:  *
jjg@1606:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jjg@1606:  * or visit www.oracle.com if you need additional information or have any
jjg@1606:  * questions.
jjg@1606:  */
jjg@1606: 
jjg@1606: package com.sun.tools.doclets.internal.toolkit.taglets;
jjg@1606: 
jjg@1606: import com.sun.javadoc.Tag;
jjg@1606: 
jjg@1606: /**
jjg@1606:  * An abstract class that implements the {@link Taglet} interface and
jjg@1606:  * serves as a base for JavaFX property getter and setter taglets.
jjg@1606:  *
jjg@1606:  *  <p><b>This is NOT part of any supported API.
jjg@1606:  *  If you write code that depends on this, you do so at your own risk.
jjg@1606:  *  This code and its internal interfaces are subject to change or
jjg@1606:  *  deletion without notice.</b>
jjg@1606:  *
jjg@1606:  */
jjg@1606: public abstract class BasePropertyTaglet extends BaseTaglet {
jjg@1606: 
jjg@1606:     public BasePropertyTaglet() {
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * This method returns the text to be put in the resulting javadoc before
jjg@1606:      * the property name.
jjg@1606:      *
jjg@1606:      * @param tagletWriter the taglet writer for output
jjg@1606:      * @return the string to be put in the resulting javadoc.
jjg@1606:      */
jjg@1606:     abstract String getText(TagletWriter tagletWriter);
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Given the <code>Tag</code> representation of this custom
jjg@1606:      * tag, return its string representation, which is output
jjg@1606:      * to the generated page.
jjg@1606:      * @param tag the <code>Tag</code> representation of this custom tag.
jjg@1606:      * @param tagletWriter the taglet writer for output.
jjg@1606:      * @return the TagletOutput representation of this <code>Tag</code>.
jjg@1606:      */
jjg@1606:     public TagletOutput getTagletOutput(Tag tag, TagletWriter tagletWriter) {
jjg@1749:         return tagletWriter.propertyTagOutput(tag, getText(tagletWriter));
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Will return false because this tag may
jjg@1606:      * only appear in Methods.
jjg@1606:      * @return false since this is not a method.
jjg@1606:      */
jjg@1606:     public boolean inConstructor() {
jjg@1606:         return false;
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Will return false because this tag may
jjg@1606:      * only appear in Methods.
jjg@1606:      * @return false since this is not a method.
jjg@1606:      */
jjg@1606:     public boolean inOverview() {
jjg@1606:         return false;
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Will return false because this tag may
jjg@1606:      * only appear in Methods.
jjg@1606:      * @return false since this is not a method.
jjg@1606:      */
jjg@1606:     public boolean inPackage() {
jjg@1606:         return false;
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Will return false because this tag may
jjg@1606:      * only appear in Methods.
jjg@1606:      * @return false since this is not a method.
jjg@1606:      */
jjg@1606:     public boolean inType() {
jjg@1606:         return false;
jjg@1606:     }
jjg@1606: 
jjg@1606:     /**
jjg@1606:      * Will return false because this tag is not inline.
jjg@1606:      * @return false since this is not an inline tag.
jjg@1606:      */
jjg@1606:     public boolean isInlineTag() {
jjg@1606:         return false;
jjg@1606:     }
jjg@1606: 
jjg@1606: }