Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java@ccbe7ffdd867 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LegacyTaglet.java
Sun, 24 Feb 2013 11:36:58 -0800
- author
- jjg
- date
- Sun, 24 Feb 2013 11:36:58 -0800
- changeset 1606
- ccbe7ffdd867
- parent 1359
- 25e14ad23cef
- child 1751
- ca8808c88f94
- permissions
- -rw-r--r--
7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com
| duke@1 | 1 | /* |
| jjg@1359 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | |
| duke@1 | 30 | /** |
| duke@1 | 31 | * This taglet acts as a wrapper to enable |
| duke@1 | 32 | * {@link com.sun.tools.doclets.Taglet} type taglets to work |
| duke@1 | 33 | * with the current version of Javadoc. |
| duke@1 | 34 | * Note: this taglet only works with legacy taglets (those compatible with |
| duke@1 | 35 | * Javadoc 1.4.x) that writes strings. |
| duke@1 | 36 | * This taglet is able to wrap most most legacy taglets because |
| duke@1 | 37 | * the standard doclet is the only known doclet to use legacy taglets. |
| duke@1 | 38 | * |
| jjg@1359 | 39 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 40 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 41 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 42 | * deletion without notice.</b> |
| duke@1 | 43 | * |
| duke@1 | 44 | * @since 1.5 |
| duke@1 | 45 | * @author Jamie Ho |
| duke@1 | 46 | */ |
| duke@1 | 47 | |
| duke@1 | 48 | public class LegacyTaglet implements Taglet { |
| duke@1 | 49 | |
| duke@1 | 50 | private com.sun.tools.doclets.Taglet legacyTaglet; |
| duke@1 | 51 | |
| duke@1 | 52 | public LegacyTaglet(com.sun.tools.doclets.Taglet t) { |
| duke@1 | 53 | legacyTaglet = t; |
| duke@1 | 54 | } |
| duke@1 | 55 | |
| duke@1 | 56 | /** |
| duke@1 | 57 | * {@inheritDoc} |
| duke@1 | 58 | */ |
| duke@1 | 59 | public boolean inField() { |
| duke@1 | 60 | return legacyTaglet.isInlineTag() || legacyTaglet.inField(); |
| duke@1 | 61 | } |
| duke@1 | 62 | |
| duke@1 | 63 | /** |
| duke@1 | 64 | * {@inheritDoc} |
| duke@1 | 65 | */ |
| duke@1 | 66 | public boolean inConstructor() { |
| duke@1 | 67 | return legacyTaglet.isInlineTag() || legacyTaglet.inConstructor(); |
| duke@1 | 68 | } |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * {@inheritDoc} |
| duke@1 | 72 | */ |
| duke@1 | 73 | public boolean inMethod() { |
| duke@1 | 74 | return legacyTaglet.isInlineTag() || legacyTaglet.inMethod(); |
| duke@1 | 75 | } |
| duke@1 | 76 | |
| duke@1 | 77 | /** |
| duke@1 | 78 | * {@inheritDoc} |
| duke@1 | 79 | */ |
| duke@1 | 80 | public boolean inOverview() { |
| duke@1 | 81 | return legacyTaglet.isInlineTag() || legacyTaglet.inOverview(); |
| duke@1 | 82 | } |
| duke@1 | 83 | |
| duke@1 | 84 | /** |
| duke@1 | 85 | * {@inheritDoc} |
| duke@1 | 86 | */ |
| duke@1 | 87 | public boolean inPackage() { |
| duke@1 | 88 | return legacyTaglet.isInlineTag() || legacyTaglet.inPackage(); |
| duke@1 | 89 | } |
| duke@1 | 90 | |
| duke@1 | 91 | /** |
| duke@1 | 92 | * {@inheritDoc} |
| duke@1 | 93 | */ |
| duke@1 | 94 | public boolean inType() { |
| duke@1 | 95 | return legacyTaglet.isInlineTag() || legacyTaglet.inType(); |
| duke@1 | 96 | } |
| duke@1 | 97 | |
| duke@1 | 98 | /** |
| duke@1 | 99 | * Return true if this <code>Taglet</code> |
| duke@1 | 100 | * is an inline tag. |
| duke@1 | 101 | * @return true if this <code>Taglet</code> |
| duke@1 | 102 | * is an inline tag and false otherwise. |
| duke@1 | 103 | */ |
| duke@1 | 104 | public boolean isInlineTag() { |
| duke@1 | 105 | return legacyTaglet.isInlineTag(); |
| duke@1 | 106 | } |
| duke@1 | 107 | |
| duke@1 | 108 | /** |
| duke@1 | 109 | * {@inheritDoc} |
| duke@1 | 110 | */ |
| duke@1 | 111 | public String getName() { |
| duke@1 | 112 | return legacyTaglet.getName(); |
| duke@1 | 113 | } |
| duke@1 | 114 | |
| duke@1 | 115 | /** |
| duke@1 | 116 | * {@inheritDoc} |
| duke@1 | 117 | */ |
| duke@1 | 118 | public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) |
| duke@1 | 119 | throws IllegalArgumentException { |
| duke@1 | 120 | TagletOutput output = writer.getOutputInstance(); |
| duke@1 | 121 | output.setOutput(legacyTaglet.toString(tag)); |
| duke@1 | 122 | return output; |
| duke@1 | 123 | } |
| duke@1 | 124 | |
| duke@1 | 125 | /** |
| duke@1 | 126 | * {@inheritDoc} |
| duke@1 | 127 | */ |
| duke@1 | 128 | public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) |
| duke@1 | 129 | throws IllegalArgumentException { |
| duke@1 | 130 | TagletOutput output = writer.getOutputInstance(); |
| duke@1 | 131 | output.setOutput(legacyTaglet.toString(holder.tags(getName()))); |
| duke@1 | 132 | return output; |
| duke@1 | 133 | } |
| duke@1 | 134 | } |
