Extension SDK 9.0.5

oracle.jdeveloper.jot
Interface JotDocLinkTag

All Superinterfaces:
JotCodeElement, JotDocTag, JotElement

public interface JotDocLinkTag
extends JotDocTag

The JotDocLinkTag interface represents instances of link tags inside of a JavaDoc comment block.


Method Summary
 int getLength()
          Retrieves the length of this element.
 java.lang.String getReferencedClassName()
           
 JotType getReferencedClassType()
           
 java.lang.String getReferencedMemberName()
           
 int getTextOffset()
           
 
Methods inherited from interface oracle.jdeveloper.jot.JotDocTag
getTagName, getTagText, getTextTags, isLinkTag, isParamTag, isReturnTag, isSeeTag, isSerialFieldTag, isTextTag, isThrowsTag, setTagName, setTagText
 
Methods inherited from interface oracle.jdeveloper.jot.JotCodeElement
addPrecedingComment, childrenContainErrors, delete, getContainingJotFile, getLeftWhitespace, getRightWhitespace, isInError, isSource, setLeftWhitespace, setRightWhitespace
 
Methods inherited from interface oracle.jdeveloper.jot.JotElement
getChildren, getContainedElements, getElementName, getElementType, getEndOffset, getID, getJotWorkArea, getParent, getStartOffset, isExistent, isReadOnly, isStructureKnown, setParent
 

Method Detail

getReferencedClassType

public JotType getReferencedClassType()
                               throws JotInvalidElementException
Returns:
the JotType of the referenced class.
Throws:
JotInvalidElementException

getReferencedClassName

public java.lang.String getReferencedClassName()
                                        throws JotInvalidElementException
Returns:
the name of the referenced class.
Throws:
JotInvalidElementException

getReferencedMemberName

public java.lang.String getReferencedMemberName()
                                         throws JotInvalidElementException
Returns:
the name of the member referenced.
Throws:
JotInvalidElementException

getTextOffset

public int getTextOffset()
                  throws JotInvalidElementException
Returns:
the offset in the comment text string where this link tag begins.
Throws:
JotInvalidElementException

getLength

public int getLength()
              throws JotInvalidElementException
Description copied from interface: JotCodeElement
Retrieves the length of this element.

Specified by:
getLength in interface JotCodeElement
Returns:
the length of this link tag.
Throws:
JotInvalidElementException

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.