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 */ 25 26 package com.sun.tools.doclets.internal.toolkit.taglets; 27 28 import com.sun.javadoc.Tag; 29 import com.sun.tools.doclets.internal.toolkit.Content; 30 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 { 42 43 public BasePropertyTaglet() { 44 } 45 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); 54 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 } 66 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 } 75 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 } 84 | 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 26 package jdk.javadoc.internal.doclets.toolkit.taglets; 27 28 import javax.lang.model.element.Element; 29 30 import com.sun.source.doctree.DocTree; 31 import 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 */ 43 public 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 |