DocRootTaglet.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2001, 2016, 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
26package jdk.javadoc.internal.doclets.toolkit.taglets;
27
28import javax.lang.model.element.Element;
29
30import com.sun.source.doctree.DocTree;
31import jdk.javadoc.internal.doclets.toolkit.Content;
32
33import static com.sun.source.doctree.DocTree.Kind.*;
34
35/**
36 * An inline Taglet representing {@docRoot}.  This taglet is
37 * used to get the relative path to the document's root output
38 * directory.
39 *
40 *  <p><b>This is NOT part of any supported API.
41 *  If you write code that depends on this, you do so at your own risk.
42 *  This code and its internal interfaces are subject to change or
43 *  deletion without notice.</b>
44 *
45 * @author Jamie Ho
46 * @author Doug Kramer
47 */
48
49public class DocRootTaglet extends BaseInlineTaglet {
50
51
52    /**
53     * Construct a new DocRootTaglet.
54     */
55    public DocRootTaglet() {
56        name = DOC_ROOT.tagName;
57    }
58
59    /**
60     * Given a <code>Doc</code> object, check if it holds any tags of
61     * this type.  If it does, return the string representing the output.
62     * If it does not, return null.
63     * @param holder
64     * @param tag a tag representing the custom tag.
65     * @param writer a {@link TagletWriter} Taglet writer.
66     * @return the string representation of this <code>Tag</code>.
67     */
68    public Content getTagletOutput(Element holder, DocTree tag, TagletWriter writer) {
69        return writer.getDocRootOutput();
70    }
71}
72