Class ThrowsTaglet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseExecutableMemberTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.ThrowsTaglet
-
- All Implemented Interfaces:
InheritableTaglet
,Taglet
@Deprecated public class ThrowsTaglet extends BaseExecutableMemberTaglet implements InheritableTaglet
Deprecated.A taglet that represents the @throws tag.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.4
- Author:
- Jamie Ho
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
-
Constructor Summary
Constructors Constructor Description ThrowsTaglet()
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Content
getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given aDoc
object, check if it holds any tags of this type.void
inherit(DocFinder.Input input, DocFinder.Output output)
Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.protected Content
throwsTagsOutput(ThrowsTag[] throwTags, TagletWriter writer, Set<String> alreadyDocumented, boolean allowDups)
Deprecated.Given an array ofTag
s representing this custom tag, return its string representation.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseExecutableMemberTaglet
inField, inOverview, inPackage, inType, isInlineTag
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inConstructor, inMethod
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.Taglet
getName, getTagletOutput, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString
-
-
-
-
Method Detail
-
inherit
public void inherit(DocFinder.Input input, DocFinder.Output output)
Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.- Specified by:
inherit
in interfaceInheritableTaglet
- Parameters:
input
- the input for documentation search.output
- the output for documentation search.
-
getTagletOutput
public Content getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given aDoc
object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
holder
- aDoc
object holding the custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the TagletOutput representation of this
Tag
.
-
throwsTagsOutput
protected Content throwsTagsOutput(ThrowsTag[] throwTags, TagletWriter writer, Set<String> alreadyDocumented, boolean allowDups)
Deprecated.Given an array ofTag
s representing this custom tag, return its string representation.- Parameters:
throwTags
- the array ofThrowsTag
s to convert.writer
- the TagletWriter that will write this tag.alreadyDocumented
- the set of exceptions that have already been documented.allowDups
- True if we allow duplicate throws tags to be documented.- Returns:
- the Content representation of this
Tag
.
-
-