1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/test/com/sun/javadoc/testLegacyTaglet/UnderlineTaglet.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,136 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2007, 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.
1.11 + *
1.12 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.13 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.14 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.15 + * version 2 for more details (a copy is included in the LICENSE file that
1.16 + * accompanied this code).
1.17 + *
1.18 + * You should have received a copy of the GNU General Public License version
1.19 + * 2 along with this work; if not, write to the Free Software Foundation,
1.20 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.21 + *
1.22 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.23 + * or visit www.oracle.com if you need additional information or have any
1.24 + * questions.
1.25 + */
1.26 +
1.27 +import com.sun.tools.doclets.Taglet;
1.28 +import com.sun.javadoc.*;
1.29 +import java.util.Map;
1.30 +
1.31 +/**
1.32 + * A sample Inline Taglet representing {@underline ...}. This tag can be used in any kind of
1.33 + * {@link com.sun.javadoc.Doc}. The text is simple underlined. For
1.34 + * example, "@underline UNDERLINE ME" would be shown as: <u>UNDERLINE ME</u>.
1.35 + *
1.36 + * @author Jamie Ho
1.37 + * @since 1.4
1.38 + */
1.39 +
1.40 +public class UnderlineTaglet implements Taglet {
1.41 +
1.42 + private String NAME = "underline";
1.43 +
1.44 + /**
1.45 + * Return the name of this custom tag.
1.46 + */
1.47 + public String getName() {
1.48 + return NAME;
1.49 + }
1.50 +
1.51 + /**
1.52 + * Will return false since this is an inline tag.
1.53 + * @return false since this is an inline tag.
1.54 + */
1.55 + public boolean inField() {
1.56 + return false;
1.57 + }
1.58 +
1.59 + /**
1.60 + * Will return false since this is an inline tag.
1.61 + * @return false since this is an inline tag.
1.62 + */
1.63 + public boolean inConstructor() {
1.64 + return true;
1.65 + }
1.66 +
1.67 + /**
1.68 + * Will return false since this is an inline tag.
1.69 + * @return false since this is an inline tag.
1.70 + */
1.71 + public boolean inMethod() {
1.72 + return false;
1.73 + }
1.74 +
1.75 + /**
1.76 + * Will return false since this is an inline tag.
1.77 + * @return false since this is an inline tag.
1.78 + */
1.79 + public boolean inOverview() {
1.80 + return false;
1.81 + }
1.82 +
1.83 + /**
1.84 + * Will return false since this is an inline tag.
1.85 + * @return false since this is an inline tag.
1.86 + */
1.87 + public boolean inPackage() {
1.88 + return false;
1.89 + }
1.90 +
1.91 + /**
1.92 + * Will return false since this is an inline tag.
1.93 + * @return false since this is an inline tag.
1.94 + */
1.95 + public boolean inType() {
1.96 + return false;
1.97 + }
1.98 +
1.99 + /**
1.100 + * Will return true since this is an inline tag.
1.101 + * @return true since this is an inline tag.
1.102 + */
1.103 +
1.104 + public boolean isInlineTag() {
1.105 + return true;
1.106 + }
1.107 +
1.108 + /**
1.109 + * Register this Taglet.
1.110 + * @param tagletMap the map to register this tag to.
1.111 + */
1.112 + public static void register(Map tagletMap) {
1.113 + UnderlineTaglet tag = new UnderlineTaglet();
1.114 + Taglet t = (Taglet) tagletMap.get(tag.getName());
1.115 + if (t != null) {
1.116 + tagletMap.remove(tag.getName());
1.117 + }
1.118 + tagletMap.put(tag.getName(), tag);
1.119 + }
1.120 +
1.121 + /**
1.122 + * Given the <code>Tag</code> representation of this custom
1.123 + * tag, return its string representation.
1.124 + * @param tag he <code>Tag</code> representation of this custom tag.
1.125 + */
1.126 + public String toString(Tag tag) {
1.127 + return "<u>" + tag.text() + "</u>";
1.128 + }
1.129 +
1.130 + /**
1.131 + * This method should not be called since arrays of inline tags do not
1.132 + * exist. Method {@link #tostring(Tag)} should be used to convert this
1.133 + * inline tag to a string.
1.134 + * @param tags the array of <code>Tag</code>s representing of this custom tag.
1.135 + */
1.136 + public String toString(Tag[] tags) {
1.137 + return null;
1.138 + }
1.139 +}
