com.sun.tools.doclets.formats.html
Class LinkInfoImpl

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo
      com.sun.tools.doclets.formats.html.LinkInfoImpl

public class LinkInfoImpl
extends LinkInfo

Field Summary

static int	ALL_CLASSES_FRAME Indicate that the link appears in a class list.
int	context The integer indicating the location of the link.
static int	CONTEXT_ANNOTATION Annotation link.
static int	CONTEXT_CLASS Indicate that the link appears in a class documentation.
static int	CONTEXT_CLASS_HEADER The header in the class documentation.
static int	CONTEXT_CLASS_SIGNATURE The signature in the class documentation.
static int	CONTEXT_CLASS_SIGNATURE_PARENT_NAME The signature in the class documentation (implements/extends portion).
static int	CONTEXT_CLASS_TREE_PARENT The parent nodes int the class tree.
static int	CONTEXT_CLASS_USE Indicate that the link appears in class use documentation.
static int	CONTEXT_CLASS_USE_HEADER Indicate that the link appears in class use documentation.
static int	CONTEXT_CONSTANT_SUMMARY Indicate that the link appears in constant value summary.
static int	CONTEXT_EXECUTABLE_MEMBER_PARAM The type of a method/constructor parameter.
static int	CONTEXT_FIELD_DOC_COPY The header for field documentation copied from parent.
static int	CONTEXT_IMPLEMENTED_CLASSES Implemented class links.
static int	CONTEXT_IMPLEMENTED_INTERFACES Implemented interface links.
static int	CONTEXT_INDEX Indicate that the link appears in index documentation.
static int	CONTEXT_MEMBER Indicate that the link appears in member documentation.
static int	CONTEXT_MEMBER_TYPE_PARAMS The type parameters of a method or constructor.
static int	CONTEXT_METHOD_DOC_COPY The header for method documentation copied from parent.
static int	CONTEXT_METHOD_OVERRIDES Method "overrides" link.
static int	CONTEXT_METHOD_SPECIFIED_BY Method "specified by" link.
static int	CONTEXT_PACKAGE Indicate that the link appears in package documentation.
static int	CONTEXT_RETURN_TYPE The return type of a method.
static int	CONTEXT_SEE_TAG Indicate that the link appears in see tag documentation.
static int	CONTEXT_SERIAL_MEMBER Indicate that the link appears in serial member documentation.
static int	CONTEXT_SERIALIZED_FORM Indicate that the link appears in serialized form documentation.
static int	CONTEXT_SUBCLASSES Subclasses links.
static int	CONTEXT_SUBINTERFACES Subinterface links.
static int	CONTEXT_SUMMARY_RETURN_TYPE The return type of a method in a member summary.
static int	CONTEXT_SUPER_INTERFACES Super interface links.
static int	CONTEXT_TREE Indicate that the link appears in tree documentation.
static int	CONTEXT_VALUE_TAG Indicate that the link appears in value tag documentation.
static int	PACKAGE_FRAME Indicate that the link appears in a class list.
java.lang.String	styleName String style of text defined in style sheet.
java.lang.String	target The valueof the target.
java.lang.String	where The value of the marker #.

Fields inherited from class com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

classDoc, displayLength, excludeTypeBounds, excludeTypeBoundsLinks, excludeTypeParameterLinks, executableMemberDoc, includeTypeAsSepLink, includeTypeInClassLinkLabel, isStrong, isTypeBound, isVarArg, label, linkToSelf, type

Constructor Summary

LinkInfoImpl(ClassDoc classDoc, java.lang.String label)
Construct a LinkInfo object.

LinkInfoImpl(int context, ClassDoc classDoc, boolean isStrong)
Construct a LinkInfo object.

LinkInfoImpl(int context, ClassDoc classDoc, java.lang.String label, boolean isStrong)
Construct a LinkInfo object.

LinkInfoImpl(int context, ClassDoc classDoc, java.lang.String label, java.lang.String target)
Construct a LinkInfo object.

LinkInfoImpl(int context, ClassDoc classDoc, java.lang.String where, java.lang.String label, boolean isStrong)
Construct a LinkInfo object.

LinkInfoImpl(int context, ClassDoc classDoc, java.lang.String where, java.lang.String label, boolean isStrong, java.lang.String styleName)
Construct a LinkInfo object.

LinkInfoImpl(int context, ExecutableMemberDoc executableMemberDoc, boolean isStrong)
Construct a LinkInfo object.

LinkInfoImpl(int context, Type type)
Construct a LinkInfo object.

LinkInfoImpl(int context, Type type, boolean isVarArg)
Construct a LinkInfo object.

LinkInfoImpl(int context, Type type, java.lang.String label, boolean isStrong)
Construct a LinkInfo object.

Method Summary

int	getContext() Return the id indicating where the link appears in the documentation.
boolean	isLinkable() Return true if this link is linkable and false if we can't link to the desired place.
void	setContext(int c) Set the context. This method sets the link attributes to the appropriate values based on the context.

Methods inherited from class com.sun.tools.doclets.internal.toolkit.util.links.LinkInfo

getClassLinkLabel

Methods inherited from class java.lang.Object

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

Field Detail

ALL_CLASSES_FRAME

public static final int ALL_CLASSES_FRAME

Indicate that the link appears in a class list.

See Also:

Constant Field Values

CONTEXT_CLASS

public static final int CONTEXT_CLASS

Indicate that the link appears in a class documentation.

See Also:

Constant Field Values

CONTEXT_MEMBER

public static final int CONTEXT_MEMBER

Indicate that the link appears in member documentation.

See Also:

Constant Field Values

CONTEXT_CLASS_USE

public static final int CONTEXT_CLASS_USE

Indicate that the link appears in class use documentation.

See Also:

Constant Field Values

CONTEXT_INDEX

public static final int CONTEXT_INDEX

Indicate that the link appears in index documentation.

See Also:

Constant Field Values

CONTEXT_CONSTANT_SUMMARY

public static final int CONTEXT_CONSTANT_SUMMARY

Indicate that the link appears in constant value summary.

See Also:

Constant Field Values

CONTEXT_SERIALIZED_FORM

public static final int CONTEXT_SERIALIZED_FORM

Indicate that the link appears in serialized form documentation.

See Also:

Constant Field Values

CONTEXT_SERIAL_MEMBER

public static final int CONTEXT_SERIAL_MEMBER

Indicate that the link appears in serial member documentation.

See Also:

Constant Field Values

CONTEXT_PACKAGE

public static final int CONTEXT_PACKAGE

Indicate that the link appears in package documentation.

See Also:

Constant Field Values

CONTEXT_SEE_TAG

public static final int CONTEXT_SEE_TAG

Indicate that the link appears in see tag documentation.

See Also:

Constant Field Values

CONTEXT_VALUE_TAG

public static final int CONTEXT_VALUE_TAG

Indicate that the link appears in value tag documentation.

See Also:

Constant Field Values

CONTEXT_TREE

public static final int CONTEXT_TREE

Indicate that the link appears in tree documentation.

See Also:

Constant Field Values

PACKAGE_FRAME

public static final int PACKAGE_FRAME

Indicate that the link appears in a class list.

See Also:

Constant Field Values

CONTEXT_CLASS_HEADER

public static final int CONTEXT_CLASS_HEADER

The header in the class documentation.

See Also:

Constant Field Values

CONTEXT_CLASS_SIGNATURE

public static final int CONTEXT_CLASS_SIGNATURE

The signature in the class documentation.

See Also:

Constant Field Values

CONTEXT_RETURN_TYPE

public static final int CONTEXT_RETURN_TYPE

The return type of a method.

See Also:

Constant Field Values

CONTEXT_SUMMARY_RETURN_TYPE

public static final int CONTEXT_SUMMARY_RETURN_TYPE

The return type of a method in a member summary.

See Also:

Constant Field Values

CONTEXT_EXECUTABLE_MEMBER_PARAM

public static final int CONTEXT_EXECUTABLE_MEMBER_PARAM

The type of a method/constructor parameter.

See Also:

Constant Field Values

CONTEXT_SUPER_INTERFACES

public static final int CONTEXT_SUPER_INTERFACES

Super interface links.

See Also:

Constant Field Values

CONTEXT_IMPLEMENTED_INTERFACES

public static final int CONTEXT_IMPLEMENTED_INTERFACES

Implemented interface links.

See Also:

Constant Field Values

CONTEXT_IMPLEMENTED_CLASSES

public static final int CONTEXT_IMPLEMENTED_CLASSES

Implemented class links.

See Also:

Constant Field Values

CONTEXT_SUBINTERFACES

public static final int CONTEXT_SUBINTERFACES

Subinterface links.

See Also:

Constant Field Values

CONTEXT_SUBCLASSES

public static final int CONTEXT_SUBCLASSES

Subclasses links.

See Also:

Constant Field Values

CONTEXT_CLASS_SIGNATURE_PARENT_NAME

public static final int CONTEXT_CLASS_SIGNATURE_PARENT_NAME

The signature in the class documentation (implements/extends portion).

See Also:

Constant Field Values

CONTEXT_METHOD_DOC_COPY

public static final int CONTEXT_METHOD_DOC_COPY

The header for method documentation copied from parent.

See Also:

Constant Field Values

CONTEXT_METHOD_SPECIFIED_BY

public static final int CONTEXT_METHOD_SPECIFIED_BY

Method "specified by" link.

See Also:

Constant Field Values

CONTEXT_METHOD_OVERRIDES

public static final int CONTEXT_METHOD_OVERRIDES

Method "overrides" link.

See Also:

Constant Field Values

CONTEXT_ANNOTATION

public static final int CONTEXT_ANNOTATION

Annotation link.

See Also:

Constant Field Values

CONTEXT_FIELD_DOC_COPY

public static final int CONTEXT_FIELD_DOC_COPY

The header for field documentation copied from parent.

See Also:

Constant Field Values

CONTEXT_CLASS_TREE_PARENT

public static final int CONTEXT_CLASS_TREE_PARENT

The parent nodes int the class tree.

See Also:

Constant Field Values

CONTEXT_MEMBER_TYPE_PARAMS

public static final int CONTEXT_MEMBER_TYPE_PARAMS

The type parameters of a method or constructor.

See Also:

Constant Field Values

CONTEXT_CLASS_USE_HEADER

public static final int CONTEXT_CLASS_USE_HEADER

Indicate that the link appears in class use documentation.

See Also:

Constant Field Values

context

public int context

The integer indicating the location of the link.

where

public java.lang.String where

The value of the marker #.

styleName

public java.lang.String styleName

String style of text defined in style sheet.

target

public java.lang.String target

The valueof the target.

Constructor Detail

LinkInfoImpl

public LinkInfoImpl(int context,
                    ClassDoc classDoc,
                    java.lang.String label,
                    java.lang.String target)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

classDoc - the class to link to.

label - the label for the link.

target - the value of the target attribute.

LinkInfoImpl

public LinkInfoImpl(int context,
                    ClassDoc classDoc,
                    java.lang.String where,
                    java.lang.String label,
                    boolean isStrong,
                    java.lang.String styleName)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

classDoc - the class to link to.

where - the value of the marker #.

label - the label for the link.

isStrong - true if the link should be strong.

styleName - String style of text defined in style sheet.

LinkInfoImpl

public LinkInfoImpl(int context,
                    ClassDoc classDoc,
                    java.lang.String where,
                    java.lang.String label,
                    boolean isStrong)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

classDoc - the class to link to.

where - the value of the marker #.

label - the label for the link.

isStrong - true if the link should be strong.

LinkInfoImpl

public LinkInfoImpl(ClassDoc classDoc,
                    java.lang.String label)

Construct a LinkInfo object.

Parameters:

classDoc - the class to link to.

label - the label for the link.

LinkInfoImpl

public LinkInfoImpl(int context,
                    ExecutableMemberDoc executableMemberDoc,
                    boolean isStrong)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

executableMemberDoc - the member to link to.

isStrong - true if the link should be strong.

LinkInfoImpl

public LinkInfoImpl(int context,
                    ClassDoc classDoc,
                    boolean isStrong)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

classDoc - the class to link to.

isStrong - true if the link should be strong.

LinkInfoImpl

public LinkInfoImpl(int context,
                    Type type)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

type - the class to link to.

LinkInfoImpl

public LinkInfoImpl(int context,
                    Type type,
                    boolean isVarArg)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

type - the class to link to.

isVarArg - true if this is a link to a var arg.

LinkInfoImpl

public LinkInfoImpl(int context,
                    Type type,
                    java.lang.String label,
                    boolean isStrong)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

type - the class to link to.

label - the label for the link.

isStrong - true if the link should be strong.

LinkInfoImpl

public LinkInfoImpl(int context,
                    ClassDoc classDoc,
                    java.lang.String label,
                    boolean isStrong)

Construct a LinkInfo object.

Parameters:

context - the context of the link.

classDoc - the class to link to.

label - the label for the link.

isStrong - true if the link should be strong.

Method Detail

getContext

public int getContext()

Return the id indicating where the link appears in the documentation. This is used for special processing of different types of links.

Specified by:

getContext in class LinkInfo

Returns:

the id indicating where the link appears in the documentation.

setContext

public void setContext(int c)

Set the context. This method sets the link attributes to the appropriate values based on the context.

Specified by:

setContext in class LinkInfo

Parameters:

c - the context id to set.

isLinkable

public boolean isLinkable()

Return true if this link is linkable and false if we can't link to the desired place.

Specified by:

isLinkable in class LinkInfo

Returns:

true if this link is linkable and false if we can't link to the desired place.