|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.doclava.LinkReference
public class LinkReference
Class that represents what you see in an link or see tag. This is factored out of SeeTagInfo so it can be used elsewhere (like AttrTagInfo).
Field Summary | |
---|---|
ClassInfo |
classInfo
The ClassInfo if any. |
boolean |
good
Set to true if everything is a-ok |
String |
href
The link. |
boolean |
isLocal
True if the link is for a page in this documentation. |
String |
kind
The kind of this tag, if we have a new suggestion after parsing. |
String |
label
The user visible text. |
MemberInfo |
memberInfo
The MemberInfo if any. |
PackageInfo |
packageInfo
The PackageInfo if any. |
String |
referencedMemberName
The name of the referenced member PackageInfo} if any. |
String |
text
The original text. |
Method Summary | |
---|---|
boolean |
checkLevel()
|
static LinkReference |
parse(String text,
ContainerInfo base,
SourcePositionInfo pos,
boolean printOnErrors)
Parse and resolve a link string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public String text
public String kind
public String label
public String href
public boolean isLocal
public PackageInfo packageInfo
PackageInfo
if any.
public ClassInfo classInfo
ClassInfo
if any.
public MemberInfo memberInfo
MemberInfo
if any.
public String referencedMemberName
public boolean good
Method Detail |
---|
public static LinkReference parse(String text, ContainerInfo base, SourcePositionInfo pos, boolean printOnErrors)
text
- the original textbase
- the class or whatever that this link is onpos
- the original position in the source document
public boolean checkLevel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |