1 /*

     2  * Copyright (c) 1997, 2012, 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.javadoc.main;

    27 

    28 import com.sun.javadoc.*;

    29 

    30 /**

    31  * Represents a @throws or @exception documentation tag.

    32  * Parses and holds the exception name and exception comment.

    33  * The exception name my be the name of a type variable.

    34  * Note: @exception is a backwards compatible synonymy for @throws.

    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  * @author Robert Field

    42  * @author Atul M Dambalkar

    43  * @see ExecutableMemberDocImpl#throwsTags()

    44  *

    45  */

    46 class ThrowsTagImpl extends TagImpl implements ThrowsTag {

    47 

    48     private final String exceptionName;

    49     private final String exceptionComment;

    50 

    51     /**

    52      * Cached inline tags.

    53      */

    54     private Tag[] inlineTags;

    55 

    56     ThrowsTagImpl(DocImpl holder, String name, String text) {

    57         super(holder, name, text);

    58         String[] sa = divideAtWhite();

    59         exceptionName = sa[0];

    60         exceptionComment = sa[1];

    61     }

    62 

    63     /**

    64      * Return the exception name.

    65      */

    66     public String exceptionName() {

    67         return exceptionName;

    68     }

    69 

    70     /**

    71      * Return the exception comment.

    72      */

    73     public String exceptionComment() {

    74         return exceptionComment;

    75     }

    76 

    77     /**

    78      * Return the exception as a ClassDocImpl.

    79      */

    80     public ClassDoc exception() {

    81         ClassDocImpl exceptionClass;

    82         if (!(holder instanceof ExecutableMemberDoc)) {

    83             exceptionClass = null;

    84         } else {

    85             ExecutableMemberDocImpl emd = (ExecutableMemberDocImpl)holder;

    86             ClassDocImpl con = (ClassDocImpl)emd.containingClass();

    87             exceptionClass = (ClassDocImpl)con.findClass(exceptionName);

    88         }

    89         return exceptionClass;

    90     }

    91 

    92     /**

    93      * Return the type that represents the exception.

    94      * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.

    95      */

    96     public Type exceptionType() {

    97         //###(gj) TypeVariable not yet supported.

    98         return exception();

    99     }

   100 

   101 

   102     /**

   103      * Return the kind of this tag.  Always "@throws" for instances

   104      * of ThrowsTagImpl.

   105      */

   106     @Override

   107     public String kind() {

   108         return "@throws";

   109     }

   110 

   111     /**

   112      * For the exception comment with embedded @link tags return the array of

   113      * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).

   114      *

   115      * @return TagImpl[] Array of tags with inline SeeTagImpls.

   116      * @see TagImpl#inlineTags()

   117      * @see ParamTagImpl#inlineTags()

   118      */

   119     @Override

   120     public Tag[] inlineTags() {

   121         if (inlineTags == null) {

   122             inlineTags = Comment.getInlineTags(holder, exceptionComment());

   123         }

   124         return inlineTags;

   125     }

   126 }