Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util

Class DocFinder.Input

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.DocFinder.Input

Enclosing class:

DocFinder

public static class DocFinder.Input
extends Object

The class that encapsulates the input.

Field Summary

Fields

Modifier and Type	Field	Description
ProgramElementDoc	element	The element to search documentation from.
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.
Tag	tag	The tag to retrieve documentation for.
String	tagId	The id of the tag to retrieve documentation for.
InheritableTaglet	taglet	The taglet to search for documentation on behalf of.

Constructor Summary

Constructors

Constructor	Description
Input(ProgramElementDoc element)
Input(ProgramElementDoc element, boolean isFirstSentence)
Input(ProgramElementDoc element, InheritableTaglet taglet)
Input(ProgramElementDoc element, InheritableTaglet taglet, Tag tag, boolean isFirstSentence, boolean isInheritDocTag)
Input(ProgramElementDoc element, InheritableTaglet taglet, String tagId)
Input(ProgramElementDoc element, InheritableTaglet taglet, String tagId, boolean isTypeVariableParamTag)

Method Summary

Modifier and Type	Method	Description
DocFinder.Input	copy()

Methods inherited from class java.lang.Object

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

Field Detail

element

public ProgramElementDoc element

The element 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 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

Input

public Input(ProgramElementDoc element,
             InheritableTaglet taglet,
             Tag tag,
             boolean isFirstSentence,
             boolean isInheritDocTag)

Input

public Input(ProgramElementDoc element,
             InheritableTaglet taglet,
             String tagId)

Input

public Input(ProgramElementDoc element,
             InheritableTaglet taglet,
             String tagId,
             boolean isTypeVariableParamTag)

Input

public Input(ProgramElementDoc element,
             InheritableTaglet taglet)

Input

public Input(ProgramElementDoc element)

Input

public Input(ProgramElementDoc element,
             boolean isFirstSentence)

Method Detail

copy

public DocFinder.Input copy()