mjc

org.multijava.mjdoc.mjdoc_142
Class MjSeeTag

java.lang.Object
  extended byorg.multijava.mjdoc.mjdoc_142.MjTag
      extended byorg.multijava.mjdoc.mjdoc_142.MjSeeTag
All Implemented Interfaces:
com.sun.javadoc.SeeTag, com.sun.javadoc.Tag

public class MjSeeTag
extends MjTag
implements com.sun.javadoc.SeeTag

This class represents the content of an @see or @link tag.

Author:
David R. Cok

Field Summary
private  MjClassDoc classDoc
          Cached value of the class indicated in the tag.
static String KIND
          A constant that is the value of 'kind' for this tag.
private  String label
          Holder for the value of the label.
private  MjMemberDoc memberDoc
          Cached value of the class member indicated in the tag, if any.
private  String memberName
          Holder for the string in the tag that indicates the member, if any.
private  MjPackageDoc pkgDoc
          Cached value of the package of the class indicated in the tag.
private  String prefix
          Holder for the string in the tag that indicates the class or package.
private  boolean resolved
          Flag to indicate whether the search for the class or package has been performed.
 
Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjTag
fstags, owner, position, tags
 
Constructor Summary
MjSeeTag(com.sun.javadoc.Doc owner, String n, String t, com.sun.javadoc.SourcePosition pos)
          This constructs a tag object, parsing the given text and looking up referenced classes.
 
Method Summary
 String kind()
          An accessor that returns the 'kind' of this tag, as required by the Tag interface.
 String label()
          Returns the label part of the tag, if any.
static String[] parseArgs(String mem)
          Parses an argument string of a see or link tag into the individual strings giving the text of the argument type; returns an array of String; no lookup of types from the strings is performed.
 com.sun.javadoc.ClassDoc referencedClass()
          Returns the class referenced in the tag, if any.
 String referencedClassName()
          Returns the fully-qualified name of the class or package referenced in the tag.
 com.sun.javadoc.MemberDoc referencedMember()
          Returns the member referenced in the see or link tag, if any (otherwise null).
 String referencedMemberName()
          Returns the name of the member and signature as written in the tag.
 com.sun.javadoc.PackageDoc referencedPackage()
          Returns the package if the target of the see tag is a package name, otherwise returns null.
private  void resolve()
          Helper function to determine whether the class/package name that is in the tag is a package or a class and to create the appropriate Doc object.
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjTag
containingClass, create, firstSentenceTags, holder, inlineTags, inlineTags, name, position, resolveReference, text, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, name, position, text, toString
 

Field Detail

KIND

public static final String KIND
A constant that is the value of 'kind' for this tag.


label

private String label
Holder for the value of the label.


prefix

private String prefix
Holder for the string in the tag that indicates the class or package.


resolved

private boolean resolved
Flag to indicate whether the search for the class or package has been performed.


classDoc

private MjClassDoc classDoc
Cached value of the class indicated in the tag.


pkgDoc

private MjPackageDoc pkgDoc
Cached value of the package of the class indicated in the tag.


memberDoc

private MjMemberDoc memberDoc
Cached value of the class member indicated in the tag, if any.


memberName

private String memberName
Holder for the string in the tag that indicates the member, if any.

Constructor Detail

MjSeeTag

public MjSeeTag(com.sun.javadoc.Doc owner,
                String n,
                String t,
                com.sun.javadoc.SourcePosition pos)
This constructs a tag object, parsing the given text and looking up referenced classes. The behavior of some of the fields is a bit erratic, but tuned to match javadoc 1.3.1.

Parameters:
n - - the name of the tag, e.g. @see or @link
t - - the text of the tag
Method Detail

kind

public String kind()
An accessor that returns the 'kind' of this tag, as required by the Tag interface.

Specified by:
kind in interface com.sun.javadoc.Tag

label

public String label()
Returns the label part of the tag, if any.

Specified by:
label in interface com.sun.javadoc.SeeTag

referencedClass

public com.sun.javadoc.ClassDoc referencedClass()
Returns the class referenced in the tag, if any.

Specified by:
referencedClass in interface com.sun.javadoc.SeeTag

referencedClassName

public String referencedClassName()
Returns the fully-qualified name of the class or package referenced in the tag.

Specified by:
referencedClassName in interface com.sun.javadoc.SeeTag

referencedMember

public com.sun.javadoc.MemberDoc referencedMember()
Returns the member referenced in the see or link tag, if any (otherwise null).

Specified by:
referencedMember in interface com.sun.javadoc.SeeTag

referencedMemberName

public String referencedMemberName()
Returns the name of the member and signature as written in the tag.

Specified by:
referencedMemberName in interface com.sun.javadoc.SeeTag

referencedPackage

public com.sun.javadoc.PackageDoc referencedPackage()
Returns the package if the target of the see tag is a package name, otherwise returns null. Checks everything on CLASSPATH.

Specified by:
referencedPackage in interface com.sun.javadoc.SeeTag

resolve

private void resolve()
Helper function to determine whether the class/package name that is in the tag is a package or a class and to create the appropriate Doc object.


parseArgs

public static String[] parseArgs(String mem)
Parses an argument string of a see or link tag into the individual strings giving the text of the argument type; returns an array of String; no lookup of types from the strings is performed.


mjc

mjc is Copyright (C) 2000-2004 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. mjc is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.