duke@1: /*
jjg@1359:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
duke@1: import java.util.Map;
duke@1: import com.sun.javadoc.Tag;
duke@1: import com.sun.tools.doclets.Taglet;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * An inline Taglet used to denote literal text.
duke@1:  * The enclosed text is interpreted as not containing HTML markup or
duke@1:  * nested javadoc tags.
duke@1:  * For example, the text:
duke@1:  * <blockquote>  {@code {@literal a<B>c}}  </blockquote>
duke@1:  * displays as:
duke@1:  * <blockquote>  {@literal a<B>c}  </blockquote>
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @author Scott Seligman
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
duke@1: public class LiteralTaglet implements Taglet {
duke@1: 
duke@1:     private static final String NAME = "literal";
duke@1: 
jjg@74:     public static void register(Map<String,Taglet> map) {
duke@1:            map.remove(NAME);
duke@1:            map.put(NAME, new LiteralTaglet());
duke@1:     }
duke@1: 
duke@1:     public String getName() {
duke@1:         return NAME;
duke@1:     }
duke@1: 
duke@1:     public String toString(Tag tag) {
duke@1:         return textToString(tag.text());
duke@1:     }
duke@1: 
duke@1:     public String toString(Tag[] tags) { return null; }
duke@1: 
duke@1:     public boolean inField() { return false; }
duke@1: 
duke@1:     public boolean inConstructor() { return false; }
duke@1: 
duke@1:     public boolean inMethod() { return false; }
duke@1: 
duke@1:     public boolean inOverview() { return false; }
duke@1: 
duke@1:     public boolean inPackage() { return false; }
duke@1: 
duke@1:     public boolean inType() { return false; }
duke@1: 
duke@1:     public boolean isInlineTag() { return true; }
duke@1: 
duke@1:     /*
duke@1:      * Replace occurrences of the following characters:  < > &
duke@1:      */
duke@1:     protected static String textToString(String text) {
jjg@1362:            StringBuilder buf = new StringBuilder();
duke@1:            for (int i = 0; i < text.length(); i++) {
duke@1:                char c = text.charAt(i);
duke@1:                switch (c) {
duke@1:                    case '<':
duke@1:                           buf.append("&lt;");
duke@1:                           break;
duke@1:                    case '>':
duke@1:                           buf.append("&gt;");
duke@1:                           break;
duke@1:                    case '&':
duke@1:                           buf.append("&amp;");
duke@1:                           break;
duke@1:                    default:
duke@1:                           buf.append(c);
duke@1:                }
duke@1:            }
duke@1:            return buf.toString();
duke@1:     }
duke@1: }