com.google.doclava
Class LinkReference

java.lang.Object
  extended by com.google.doclava.LinkReference

public class LinkReference
extends Object

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

text

public String text
The original text.


kind

public String kind
The kind of this tag, if we have a new suggestion after parsing.


label

public String label
The user visible text.


href

public String href
The link.


isLocal

public boolean isLocal
True if the link is for a page in this documentation.


packageInfo

public PackageInfo packageInfo
The PackageInfo if any.


classInfo

public ClassInfo classInfo
The ClassInfo if any.


memberInfo

public MemberInfo memberInfo
The MemberInfo if any.


referencedMemberName

public String referencedMemberName
The name of the referenced member PackageInfo} if any.


good

public boolean good
Set to true if everything is a-ok

Method Detail

parse

public static LinkReference parse(String text,
                                  ContainerInfo base,
                                  SourcePositionInfo pos,
                                  boolean printOnErrors)
Parse and resolve a link string.

Parameters:
text - the original text
base - the class or whatever that this link is on
pos - the original position in the source document
Returns:
a new link reference. It always returns something. If there was an error, it logs it and fills in href and label with error text.

checkLevel

public boolean checkLevel()


Copyright © 2010-2013 Google. All Rights Reserved.