summaryrefslogtreecommitdiff
path: root/doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java
diff options
context:
space:
mode:
Diffstat (limited to 'doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java')
-rw-r--r--doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java86
1 files changed, 86 insertions, 0 deletions
diff --git a/doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java b/doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java
new file mode 100644
index 0000000..b24af85
--- /dev/null
+++ b/doclet_adapter/src/main/java/com/sun/javadoc/ThrowsTag.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package com.sun.javadoc;
+
+import com.google.doclava.annotation.Unused;
+import com.google.doclava.annotation.Used;
+
+/**
+ * Represents a @throws or @exception documentation tag.
+ * Parses and holds the exception name and exception comment.
+ * Note: @exception is a backwards compatible synonymy for @throws.
+ *
+ * @author Robert Field
+ * @author Atul M Dambalkar
+ * @see ExecutableMemberDoc#throwsTags()
+ *
+ */
+public interface ThrowsTag extends Tag {
+
+ /**
+ * Return the name of the exception
+ * associated with this <code>ThrowsTag</code>.
+ *
+ * @return name of the exception.
+ */
+ @Unused
+ String exceptionName();
+
+ /**
+ * Return the exception comment
+ * associated with this <code>ThrowsTag</code>.
+ *
+ * @return exception comment.
+ */
+ @Used
+ String exceptionComment();
+
+ /**
+ * Return a <code>ClassDoc</code> that represents the exception.
+ * If the type of the exception is a type variable, return the
+ * <code>ClassDoc</code> of its erasure.
+ *
+ * <p> <i>This method cannot accommodate certain generic type
+ * constructs. The <code>exceptionType</code> method
+ * should be used instead.</i>
+ *
+ * @return <code>ClassDoc</code> that represents the exception.
+ * @see #exceptionType
+ */
+ @Used
+ ClassDoc exception();
+
+ /**
+ * Return the type of the exception
+ * associated with this <code>ThrowsTag</code>.
+ * This may be a <code>ClassDoc</code> or a <code>TypeVariable</code>.
+ *
+ * @return the type of the exception.
+ * @since 1.5
+ */
+ @Unused
+ Type exceptionType();
+}