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

Class SimpleTaglet

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.SimpleTaglet

All Implemented Interfaces:

InheritableTaglet, Taglet

@Deprecated
public class SimpleTaglet
extends BaseTaglet
implements InheritableTaglet

Deprecated.

A simple single argument custom 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.

Author:

Jamie Ho

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL	Deprecated. Use in location string when the tag is to appear in all locations.
static String	CONSTRUCTOR	Deprecated. The marker in the location string for constructors.
static String	EXCLUDED	Deprecated. The marker in the location string for excluded tags.
static String	FIELD	Deprecated. The marker in the location string for fields.
protected String	header	Deprecated. The header to output.
protected String	locations	Deprecated. The possible locations that this tag can appear in.
static String	METHOD	Deprecated. The marker in the location string for methods.
static String	OVERVIEW	Deprecated. The marker in the location string for overview.
static String	PACKAGE	Deprecated. The marker in the location string for packages.
protected String	tagName	Deprecated. The name of this tag.
static String	TYPE	Deprecated. The marker in the location string for types.

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

name

Constructor Summary

Constructors

Constructor	Description
SimpleTaglet(String tagName, String header, String locations)	Deprecated. Construct a SimpleTaglet.

Method Summary

Modifier and Type	Method	Description
String	getName()	Deprecated. Return the name of this Taglet.
Content	getTagletOutput(Doc holder, TagletWriter writer)	Deprecated. Given a Doc object, check if it holds any tags of this type.
Content	getTagletOutput(Tag tag, TagletWriter writer)	Deprecated. Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
boolean	inConstructor()	Deprecated. Return true if this SimpleTaglet is used in constructor documentation.
boolean	inField()	Deprecated. Return true if this SimpleTaglet is used in field documentation.
void	inherit(DocFinder.Input input, DocFinder.Output output)	Deprecated. Given an DocFinder.Output object, set its values with the appropriate information to inherit documentation.
boolean	inMethod()	Deprecated. Return true if this SimpleTaglet is used in method documentation.
boolean	inOverview()	Deprecated. Return true if this SimpleTaglet is used in overview documentation.
boolean	inPackage()	Deprecated. Return true if this SimpleTaglet is used in package documentation.
boolean	inType()	Deprecated. Return true if this SimpleTaglet is used in type documentation (classes or interfaces).
boolean	isInlineTag()	Deprecated. Return true if this Taglet is an inline tag.

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

toString

Field Detail

EXCLUDED

public static final String EXCLUDED

Deprecated.

The marker in the location string for excluded tags.

See Also:

Constant Field Values

PACKAGE

public static final String PACKAGE

Deprecated.

The marker in the location string for packages.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Deprecated.

The marker in the location string for types.

See Also:

Constant Field Values

CONSTRUCTOR

public static final String CONSTRUCTOR

Deprecated.

The marker in the location string for constructors.

See Also:

Constant Field Values

FIELD

public static final String FIELD

Deprecated.

The marker in the location string for fields.

See Also:

Constant Field Values

METHOD

public static final String METHOD

Deprecated.

The marker in the location string for methods.

See Also:

Constant Field Values

OVERVIEW

public static final String OVERVIEW

Deprecated.

The marker in the location string for overview.

See Also:

Constant Field Values

ALL

public static final String ALL

Deprecated.

Use in location string when the tag is to appear in all locations.

See Also:

Constant Field Values

tagName

protected String tagName

Deprecated.

The name of this tag.

header

protected String header

Deprecated.

The header to output.

locations

protected String locations

Deprecated.

The possible locations that this tag can appear in.

Constructor Detail

SimpleTaglet

public SimpleTaglet(String tagName,
                    String header,
                    String locations)

Deprecated.

Construct a SimpleTaglet.

Parameters:

tagName - the name of this tag

header - the header to output.

locations - the possible locations that this tag can appear in. The String can contain 'p' for package, 't' for type, 'm' for method, 'c' for constructor and 'f' for field.

Method Detail

getName

public String getName()

Deprecated.

Return the name of this Taglet.

Specified by:

getName in interface Taglet

Overrides:

getName in class BaseTaglet

Returns:

the name of this custom tag.

inConstructor

public boolean inConstructor()

Deprecated.

Return true if this SimpleTaglet is used in constructor documentation.

Specified by:

inConstructor in interface Taglet

Overrides:

inConstructor in class BaseTaglet

Returns:

true if this SimpleTaglet is used in constructor documentation and false otherwise.

inField

public boolean inField()

Deprecated.

Return true if this SimpleTaglet is used in field documentation.

Specified by:

inField in interface Taglet

Overrides:

inField in class BaseTaglet

Returns:

true if this SimpleTaglet is used in field documentation and false otherwise.

inMethod

public boolean inMethod()

Deprecated.

Return true if this SimpleTaglet is used in method documentation.

Specified by:

inMethod in interface Taglet

Overrides:

inMethod in class BaseTaglet

Returns:

true if this SimpleTaglet is used in method documentation and false otherwise.

inOverview

public boolean inOverview()

Deprecated.

Return true if this SimpleTaglet is used in overview documentation.

Specified by:

inOverview in interface Taglet

Overrides:

inOverview in class BaseTaglet

Returns:

true if this SimpleTaglet is used in overview documentation and false otherwise.

inPackage

public boolean inPackage()

Deprecated.

Return true if this SimpleTaglet is used in package documentation.

Specified by:

inPackage in interface Taglet

Overrides:

inPackage in class BaseTaglet

Returns:

true if this SimpleTaglet is used in package documentation and false otherwise.

inType

public boolean inType()

Deprecated.

Return true if this SimpleTaglet is used in type documentation (classes or interfaces).

Specified by:

inType in interface Taglet

Overrides:

inType in class BaseTaglet

Returns:

true if this SimpleTaglet is used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()

Deprecated.

Return true if this Taglet is an inline tag.

Specified by:

isInlineTag in interface Taglet

Overrides:

isInlineTag in class BaseTaglet

Returns:

true if this Taglet is an inline tag and false otherwise.

inherit

public void inherit(DocFinder.Input input,
                    DocFinder.Output output)

Deprecated.

Description copied from interface: InheritableTaglet

Given an DocFinder.Output object, set its values with the appropriate information to inherit documentation.

Specified by:

inherit in interface InheritableTaglet

Parameters:

input - the input for documentation search.

output - the output for documentation search.

getTagletOutput

public Content getTagletOutput(Tag tag,
                               TagletWriter writer)

Deprecated.

Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.

Specified by:

getTagletOutput in interface Taglet

Overrides:

getTagletOutput in class BaseTaglet

Parameters:

tag - the Tag representation of this custom tag.

writer - a TagletWriter Taglet writer.

Returns:

the Content representation of this Tag.

getTagletOutput

public Content getTagletOutput(Doc holder,
                               TagletWriter writer)

Deprecated.

Given a Doc 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 interface Taglet

Overrides:

getTagletOutput in class BaseTaglet

Parameters:

holder - a Doc object holding the custom tag.

writer - a TagletWriter Taglet writer.

Returns:

the TagletOutput representation of this Tag.