author | jjg |
Fri, 27 May 2016 13:06:58 -0700 | |
changeset 38617 | d93a7f64e231 |
parent 25874 | 83c19f00452c |
permissions | -rw-r--r-- |
10 | 1 |
/* |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
2 |
* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.doclets.internal.toolkit.taglets; |
|
27 |
||
28 |
import com.sun.javadoc.*; |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
29 |
import com.sun.tools.doclets.formats.html.markup.RawHtml; |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
30 |
import com.sun.tools.doclets.internal.toolkit.Content; |
10 | 31 |
|
32 |
/** |
|
33 |
* This taglet acts as a wrapper to enable |
|
34 |
* {@link com.sun.tools.doclets.Taglet} type taglets to work |
|
35 |
* with the current version of Javadoc. |
|
36 |
* Note: this taglet only works with legacy taglets (those compatible with |
|
37 |
* Javadoc 1.4.x) that writes strings. |
|
38 |
* This taglet is able to wrap most most legacy taglets because |
|
39 |
* the standard doclet is the only known doclet to use legacy taglets. |
|
40 |
* |
|
14260 | 41 |
* <p><b>This is NOT part of any supported API. |
42 |
* If you write code that depends on this, you do so at your own risk. |
|
43 |
* This code and its internal interfaces are subject to change or |
|
44 |
* deletion without notice.</b> |
|
10 | 45 |
* |
46 |
* @since 1.5 |
|
47 |
* @author Jamie Ho |
|
48 |
*/ |
|
49 |
||
38617 | 50 |
@Deprecated |
10 | 51 |
public class LegacyTaglet implements Taglet { |
52 |
||
53 |
private com.sun.tools.doclets.Taglet legacyTaglet; |
|
54 |
||
55 |
public LegacyTaglet(com.sun.tools.doclets.Taglet t) { |
|
56 |
legacyTaglet = t; |
|
57 |
} |
|
58 |
||
59 |
/** |
|
60 |
* {@inheritDoc} |
|
61 |
*/ |
|
62 |
public boolean inField() { |
|
63 |
return legacyTaglet.isInlineTag() || legacyTaglet.inField(); |
|
64 |
} |
|
65 |
||
66 |
/** |
|
67 |
* {@inheritDoc} |
|
68 |
*/ |
|
69 |
public boolean inConstructor() { |
|
70 |
return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor(); |
|
71 |
} |
|
72 |
||
73 |
/** |
|
74 |
* {@inheritDoc} |
|
75 |
*/ |
|
76 |
public boolean inMethod() { |
|
77 |
return legacyTaglet.isInlineTag() || legacyTaglet.inMethod(); |
|
78 |
} |
|
79 |
||
80 |
/** |
|
81 |
* {@inheritDoc} |
|
82 |
*/ |
|
83 |
public boolean inOverview() { |
|
84 |
return legacyTaglet.isInlineTag() || legacyTaglet.inOverview(); |
|
85 |
} |
|
86 |
||
87 |
/** |
|
88 |
* {@inheritDoc} |
|
89 |
*/ |
|
90 |
public boolean inPackage() { |
|
91 |
return legacyTaglet.isInlineTag() || legacyTaglet.inPackage(); |
|
92 |
} |
|
93 |
||
94 |
/** |
|
95 |
* {@inheritDoc} |
|
96 |
*/ |
|
97 |
public boolean inType() { |
|
98 |
return legacyTaglet.isInlineTag() || legacyTaglet.inType(); |
|
99 |
} |
|
100 |
||
101 |
/** |
|
102 |
* Return true if this <code>Taglet</code> |
|
103 |
* is an inline tag. |
|
104 |
* @return true if this <code>Taglet</code> |
|
105 |
* is an inline tag and false otherwise. |
|
106 |
*/ |
|
107 |
public boolean isInlineTag() { |
|
108 |
return legacyTaglet.isInlineTag(); |
|
109 |
} |
|
110 |
||
111 |
/** |
|
112 |
* {@inheritDoc} |
|
113 |
*/ |
|
114 |
public String getName() { |
|
115 |
return legacyTaglet.getName(); |
|
116 |
} |
|
117 |
||
118 |
/** |
|
119 |
* {@inheritDoc} |
|
120 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
121 |
public Content getTagletOutput(Tag tag, TagletWriter writer) |
10 | 122 |
throws IllegalArgumentException { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
123 |
Content output = writer.getOutputInstance(); |
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
124 |
output.addContent(new RawHtml(legacyTaglet.toString(tag))); |
10 | 125 |
return output; |
126 |
} |
|
127 |
||
128 |
/** |
|
129 |
* {@inheritDoc} |
|
130 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
131 |
public Content getTagletOutput(Doc holder, TagletWriter writer) |
10 | 132 |
throws IllegalArgumentException { |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
14260
diff
changeset
|
133 |
Content output = writer.getOutputInstance(); |
19910 | 134 |
Tag[] tags = holder.tags(getName()); |
135 |
if (tags.length > 0) { |
|
136 |
String tagString = legacyTaglet.toString(tags); |
|
137 |
if (tagString != null) { |
|
138 |
output.addContent(new RawHtml(tagString)); |
|
139 |
} |
|
140 |
} |
|
10 | 141 |
return output; |
142 |
} |
|
143 |
} |