com.sun.tools.doclets.internal.toolkit.util
Class DocFinder.Input

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.util.DocFinder.Input

Enclosing class:

DocFinder

public static class DocFinder.Input
extends java.lang.Object

The class that encapsulates the input.

Field Summary

boolean	isFirstSentence True if we only want to search for the first sentence.
boolean	isInheritDocTag True if we are looking for documentation to replace the inheritDocTag.
boolean	isTypeVariableParamTag Used to distinguish between type variable param tags and regular param tags.
MethodDoc	method The method to search documentation from.
Tag	tag The tag to retrieve documentation for.
java.lang.String	tagId The id of the tag to retrieve documentation for.
InheritableTaglet	taglet The taglet to search for documentation on behalf of.

Constructor Summary

DocFinder.Input()

DocFinder.Input(MethodDoc method)

DocFinder.Input(MethodDoc method, boolean isFirstSentence)

DocFinder.Input(MethodDoc method, InheritableTaglet taglet)

DocFinder.Input(MethodDoc method, InheritableTaglet taglet, java.lang.String tagId)

DocFinder.Input(MethodDoc method, InheritableTaglet taglet, java.lang.String tagId, boolean isTypeVariableParamTag)

DocFinder.Input(MethodDoc method, InheritableTaglet taglet, Tag tag, boolean isFirstSentence, boolean isInheritDocTag)

Method Summary

DocFinder.Input

copy()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

method

public MethodDoc method

The method to search documentation from.

taglet

public InheritableTaglet taglet

The taglet to search for documentation on behalf of. Null if we want to search for overall documentation.

tagId

public java.lang.String tagId

The id of the tag to retrieve documentation for.

tag

public Tag tag

The tag to retrieve documentation for. This is only used for the inheritDoc tag.

isFirstSentence

public boolean isFirstSentence

True if we only want to search for the first sentence.

isInheritDocTag

public boolean isInheritDocTag

True if we are looking for documentation to replace the inheritDocTag.

isTypeVariableParamTag

public boolean isTypeVariableParamTag

Used to distinguish between type variable param tags and regular param tags.

Constructor Detail

DocFinder.Input

public DocFinder.Input()

DocFinder.Input

public DocFinder.Input(MethodDoc method,
                       InheritableTaglet taglet,
                       Tag tag,
                       boolean isFirstSentence,
                       boolean isInheritDocTag)

DocFinder.Input

public DocFinder.Input(MethodDoc method,
                       InheritableTaglet taglet,
                       java.lang.String tagId)

DocFinder.Input

public DocFinder.Input(MethodDoc method,
                       InheritableTaglet taglet,
                       java.lang.String tagId,
                       boolean isTypeVariableParamTag)

DocFinder.Input

public DocFinder.Input(MethodDoc method,
                       InheritableTaglet taglet)

DocFinder.Input

public DocFinder.Input(MethodDoc method)

DocFinder.Input

public DocFinder.Input(MethodDoc method,
                       boolean isFirstSentence)

Method Detail

copy

public DocFinder.Input copy()