1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/BasePropertyTaglet.java Sun Feb 24 11:36:58 2013 -0800
1.3 @@ -0,0 +1,117 @@
1.4 +/*
1.5 + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.internal.toolkit.taglets;
1.30 +
1.31 +import com.sun.javadoc.Tag;
1.32 +
1.33 +/**
1.34 + * An abstract class that implements the {@link Taglet} interface and
1.35 + * serves as a base for JavaFX property getter and setter taglets.
1.36 + *
1.37 + * <p><b>This is NOT part of any supported API.
1.38 + * If you write code that depends on this, you do so at your own risk.
1.39 + * This code and its internal interfaces are subject to change or
1.40 + * deletion without notice.</b>
1.41 + *
1.42 + */
1.43 +public abstract class BasePropertyTaglet extends BaseTaglet {
1.44 +
1.45 + public BasePropertyTaglet() {
1.46 + }
1.47 +
1.48 + /**
1.49 + * This method returns the text to be put in the resulting javadoc before
1.50 + * the property name.
1.51 + *
1.52 + * @param tagletWriter the taglet writer for output
1.53 + * @return the string to be put in the resulting javadoc.
1.54 + */
1.55 + abstract String getText(TagletWriter tagletWriter);
1.56 +
1.57 + /**
1.58 + * Given the <code>Tag</code> representation of this custom
1.59 + * tag, return its string representation, which is output
1.60 + * to the generated page.
1.61 + * @param tag the <code>Tag</code> representation of this custom tag.
1.62 + * @param tagletWriter the taglet writer for output.
1.63 + * @return the TagletOutput representation of this <code>Tag</code>.
1.64 + */
1.65 + public TagletOutput getTagletOutput(Tag tag, TagletWriter tagletWriter) {
1.66 + TagletOutput tagletOutput = tagletWriter.getOutputInstance();
1.67 + StringBuilder output = new StringBuilder("<P>");
1.68 + output.append(getText(tagletWriter));
1.69 + output.append(" <CODE>");
1.70 + output.append(tag.text());
1.71 + output.append("</CODE>.</P>");
1.72 + tagletOutput.setOutput(output.toString());
1.73 + return tagletOutput;
1.74 + }
1.75 +
1.76 + /**
1.77 + * Will return false because this tag may
1.78 + * only appear in Methods.
1.79 + * @return false since this is not a method.
1.80 + */
1.81 + public boolean inConstructor() {
1.82 + return false;
1.83 + }
1.84 +
1.85 + /**
1.86 + * Will return false because this tag may
1.87 + * only appear in Methods.
1.88 + * @return false since this is not a method.
1.89 + */
1.90 + public boolean inOverview() {
1.91 + return false;
1.92 + }
1.93 +
1.94 + /**
1.95 + * Will return false because this tag may
1.96 + * only appear in Methods.
1.97 + * @return false since this is not a method.
1.98 + */
1.99 + public boolean inPackage() {
1.100 + return false;
1.101 + }
1.102 +
1.103 + /**
1.104 + * Will return false because this tag may
1.105 + * only appear in Methods.
1.106 + * @return false since this is not a method.
1.107 + */
1.108 + public boolean inType() {
1.109 + return false;
1.110 + }
1.111 +
1.112 + /**
1.113 + * Will return false because this tag is not inline.
1.114 + * @return false since this is not an inline tag.
1.115 + */
1.116 + public boolean isInlineTag() {
1.117 + return false;
1.118 + }
1.119 +
1.120 +}
