Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LiteralTaglet.java@24a47c3062fe (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LiteralTaglet.java
Thu, 02 Oct 2008 19:58:40 -0700
- author
- xdono
- date
- Thu, 02 Oct 2008 19:58:40 -0700
- changeset 117
- 24a47c3062fe
- parent 74
- 5a9172b251dd
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
| duke@1 | 1 | /* |
| xdono@117 | 2 | * Copyright 2003-2008 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | package com.sun.tools.doclets.internal.toolkit.taglets; |
| duke@1 | 26 | |
| duke@1 | 27 | import java.util.Map; |
| duke@1 | 28 | import com.sun.javadoc.Tag; |
| duke@1 | 29 | import com.sun.tools.doclets.Taglet; |
| duke@1 | 30 | |
| duke@1 | 31 | |
| duke@1 | 32 | /** |
| duke@1 | 33 | * An inline Taglet used to denote literal text. |
| duke@1 | 34 | * The enclosed text is interpreted as not containing HTML markup or |
| duke@1 | 35 | * nested javadoc tags. |
| duke@1 | 36 | * For example, the text: |
| duke@1 | 37 | * <blockquote> {@code {@literal a<B>c}} </blockquote> |
| duke@1 | 38 | * displays as: |
| duke@1 | 39 | * <blockquote> {@literal a<B>c} </blockquote> |
| duke@1 | 40 | * |
| duke@1 | 41 | * @author Scott Seligman |
| duke@1 | 42 | * @since 1.5 |
| duke@1 | 43 | */ |
| duke@1 | 44 | |
| duke@1 | 45 | public class LiteralTaglet implements Taglet { |
| duke@1 | 46 | |
| duke@1 | 47 | private static final String NAME = "literal"; |
| duke@1 | 48 | |
| jjg@74 | 49 | public static void register(Map<String,Taglet> map) { |
| duke@1 | 50 | map.remove(NAME); |
| duke@1 | 51 | map.put(NAME, new LiteralTaglet()); |
| duke@1 | 52 | } |
| duke@1 | 53 | |
| duke@1 | 54 | public String getName() { |
| duke@1 | 55 | return NAME; |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | public String toString(Tag tag) { |
| duke@1 | 59 | return textToString(tag.text()); |
| duke@1 | 60 | } |
| duke@1 | 61 | |
| duke@1 | 62 | public String toString(Tag[] tags) { return null; } |
| duke@1 | 63 | |
| duke@1 | 64 | public boolean inField() { return false; } |
| duke@1 | 65 | |
| duke@1 | 66 | public boolean inConstructor() { return false; } |
| duke@1 | 67 | |
| duke@1 | 68 | public boolean inMethod() { return false; } |
| duke@1 | 69 | |
| duke@1 | 70 | public boolean inOverview() { return false; } |
| duke@1 | 71 | |
| duke@1 | 72 | public boolean inPackage() { return false; } |
| duke@1 | 73 | |
| duke@1 | 74 | public boolean inType() { return false; } |
| duke@1 | 75 | |
| duke@1 | 76 | public boolean isInlineTag() { return true; } |
| duke@1 | 77 | |
| duke@1 | 78 | /* |
| duke@1 | 79 | * Replace occurrences of the following characters: < > & |
| duke@1 | 80 | */ |
| duke@1 | 81 | protected static String textToString(String text) { |
| duke@1 | 82 | StringBuffer buf = new StringBuffer(); |
| duke@1 | 83 | for (int i = 0; i < text.length(); i++) { |
| duke@1 | 84 | char c = text.charAt(i); |
| duke@1 | 85 | switch (c) { |
| duke@1 | 86 | case '<': |
| duke@1 | 87 | buf.append("<"); |
| duke@1 | 88 | break; |
| duke@1 | 89 | case '>': |
| duke@1 | 90 | buf.append(">"); |
| duke@1 | 91 | break; |
| duke@1 | 92 | case '&': |
| duke@1 | 93 | buf.append("&"); |
| duke@1 | 94 | break; |
| duke@1 | 95 | default: |
| duke@1 | 96 | buf.append(c); |
| duke@1 | 97 | } |
| duke@1 | 98 | } |
| duke@1 | 99 | return buf.toString(); |
| duke@1 | 100 | } |
| duke@1 | 101 | } |
