Mercurial > jdk8-mips64-public > langtools / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/LiteralTaglet.java	Sat Dec 01 00:00:00 2007 +0000
     1.3 @@ -0,0 +1,101 @@
     1.4 +/*
     1.5 + * Copyright 2003 Sun Microsystems, Inc.  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.  Sun designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Sun in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
    1.26 + * have any questions.
    1.27 + */
    1.28 +package com.sun.tools.doclets.internal.toolkit.taglets;
    1.29 +
    1.30 +import java.util.Map;
    1.31 +import com.sun.javadoc.Tag;
    1.32 +import com.sun.tools.doclets.Taglet;
    1.33 +
    1.34 +
    1.35 +/**
    1.36 + * An inline Taglet used to denote literal text.
    1.37 + * The enclosed text is interpreted as not containing HTML markup or
    1.38 + * nested javadoc tags.
    1.39 + * For example, the text:
    1.40 + * <blockquote>  {@code {@literal a<B>c}}  </blockquote>
    1.41 + * displays as:
    1.42 + * <blockquote>  {@literal a<B>c}  </blockquote>
    1.43 + *
    1.44 + * @author Scott Seligman
    1.45 + * @since 1.5
    1.46 + */
    1.47 +
    1.48 +public class LiteralTaglet implements Taglet {
    1.49 +
    1.50 +    private static final String NAME = "literal";
    1.51 +
    1.52 +    public static void register(Map map) {
    1.53 +           map.remove(NAME);
    1.54 +           map.put(NAME, new LiteralTaglet());
    1.55 +    }
    1.56 +
    1.57 +    public String getName() {
    1.58 +        return NAME;
    1.59 +    }
    1.60 +
    1.61 +    public String toString(Tag tag) {
    1.62 +        return textToString(tag.text());
    1.63 +    }
    1.64 +
    1.65 +    public String toString(Tag[] tags) { return null; }
    1.66 +
    1.67 +    public boolean inField() { return false; }
    1.68 +
    1.69 +    public boolean inConstructor() { return false; }
    1.70 +
    1.71 +    public boolean inMethod() { return false; }
    1.72 +
    1.73 +    public boolean inOverview() { return false; }
    1.74 +
    1.75 +    public boolean inPackage() { return false; }
    1.76 +
    1.77 +    public boolean inType() { return false; }
    1.78 +
    1.79 +    public boolean isInlineTag() { return true; }
    1.80 +
    1.81 +    /*
    1.82 +     * Replace occurrences of the following characters:  < > &
    1.83 +     */
    1.84 +    protected static String textToString(String text) {
    1.85 +           StringBuffer buf = new StringBuffer();
    1.86 +           for (int i = 0; i < text.length(); i++) {
    1.87 +               char c = text.charAt(i);
    1.88 +               switch (c) {
    1.89 +                   case '<':
    1.90 +                          buf.append("&lt;");
    1.91 +                          break;
    1.92 +                   case '>':
    1.93 +                          buf.append("&gt;");
    1.94 +                          break;
    1.95 +                   case '&':
    1.96 +                          buf.append("&amp;");
    1.97 +                          break;
    1.98 +                   default:
    1.99 +                          buf.append(c);
   1.100 +               }
   1.101 +           }
   1.102 +           return buf.toString();
   1.103 +    }
   1.104 +}