1 /*

     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.

     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

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    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  *

    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.

    24  */

    25 

    26 package com.sun.tools.doclets.internal.toolkit.taglets;

    27 

    28 import java.util.Map;

    29 

    30 import com.sun.tools.doclets.Taglet;

    31 import com.sun.javadoc.Tag;

    32 

    33 /**

    34  * An inline Taglet used to denote information for experts.

    35  *

    36  *  <p><b>This is NOT part of any supported API.

    37  *  If you write code that depends on this, you do so at your own risk.

    38  *  This code and its internal interfaces are subject to change or

    39  *  deletion without notice.</b>

    40  *

    41  */

    42 public class ExpertTaglet implements Taglet {

    43 

    44     private static final String NAME = "expert";

    45     private static final String START_TAG = "<sub id=\"expert\">";

    46     private static final String END_TAG = "</sub>";

    47 

    48     /**

    49      * {@inheritDoc}

    50      */

    51     public boolean inField() {

    52         return true;

    53     }

    54 

    55     public boolean inConstructor() {

    56         return true;

    57     }

    58 

    59     public boolean inMethod() {

    60         return true;

    61     }

    62 

    63     public boolean inOverview() {

    64         return true;

    65     }

    66 

    67     public boolean inPackage() {

    68         return true;

    69     }

    70 

    71     public boolean inType() {

    72         return true;

    73     }

    74 

    75     public boolean isInlineTag() {

    76         return false;

    77     }

    78 

    79     public String getName() {

    80         return NAME;

    81     }

    82 

    83     public static void register(Map<String, Taglet> map) {

    84         map.remove(NAME);

    85         map.put(NAME, new ExpertTaglet());

    86     }

    87 

    88     public String toString(Tag tag) {

    89         return (tag.text() == null || tag.text().length() == 0) ? null :

    90             START_TAG + LiteralTaglet.textToString(tag.text()) + END_TAG;

    91     }

    92 

    93 

    94     public String toString(Tag[] tags) {

    95         if (tags == null || tags.length == 0) return null;

    96 

    97         StringBuffer sb = new StringBuffer(START_TAG);

    98 

    99         for(Tag t:tags) {

   100             sb.append(LiteralTaglet.textToString(t.text()));

   101         }

   102         sb.append(END_TAG);

   103         return sb.toString();

   104     }

   105 

   106 }