org.jboss.apiviz
Class APIvizRootDoc

java.lang.Object
  extended by org.jboss.apiviz.APIvizRootDoc
All Implemented Interfaces:
com.sun.javadoc.Doc, com.sun.javadoc.DocErrorReporter, com.sun.javadoc.RootDoc, Comparable<Object>

public class APIvizRootDoc
extends Object
implements com.sun.javadoc.RootDoc

Version:
$Rev: 59 $, $Date: 2009-03-20 17:49:41 +0100(ven, 20 mar 2009) $
Author:
The APIviz Project (apiviz-dev@lists.jboss.org), Trustin Lee (tlee@redhat.com)

Constructor Summary
APIvizRootDoc(com.sun.javadoc.RootDoc root)
           
 
Method Summary
 com.sun.javadoc.ClassDoc[] classes()
           
 com.sun.javadoc.ClassDoc classNamed(String arg0)
           
 String commentText()
           
 int compareTo(Object arg0)
           
 com.sun.javadoc.Tag[] firstSentenceTags()
           
 String getRawCommentText()
           
 com.sun.javadoc.Tag[] inlineTags()
           
 boolean isAnnotationType()
           
 boolean isAnnotationTypeElement()
           
 boolean isClass()
           
 boolean isConstructor()
           
 boolean isEnum()
           
 boolean isEnumConstant()
           
 boolean isError()
           
 boolean isException()
           
 boolean isField()
           
 boolean isIncluded()
           
 boolean isInterface()
           
 boolean isMethod()
           
 boolean isOrdinaryClass()
           
 String name()
           
 String[][] options()
           
 com.sun.javadoc.PackageDoc packageNamed(String arg0)
           
 com.sun.javadoc.SourcePosition position()
           
 void printError(com.sun.javadoc.SourcePosition arg0, String arg1)
           
 void printError(String arg0)
           
 void printNotice(com.sun.javadoc.SourcePosition arg0, String arg1)
           
 void printNotice(String arg0)
           
 void printWarning(com.sun.javadoc.SourcePosition arg0, String arg1)
           
 void printWarning(String arg0)
           
 com.sun.javadoc.SeeTag[] seeTags()
           
 void setRawCommentText(String arg0)
           
 com.sun.javadoc.ClassDoc[] specifiedClasses()
           
 com.sun.javadoc.PackageDoc[] specifiedPackages()
           
 com.sun.javadoc.Tag[] tags()
           
 com.sun.javadoc.Tag[] tags(String arg0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

APIvizRootDoc

public APIvizRootDoc(com.sun.javadoc.RootDoc root)
Method Detail

printWarning

public void printWarning(com.sun.javadoc.SourcePosition arg0,
                         String arg1)
Specified by:
printWarning in interface com.sun.javadoc.DocErrorReporter

printWarning

public void printWarning(String arg0)
Specified by:
printWarning in interface com.sun.javadoc.DocErrorReporter

classes

public com.sun.javadoc.ClassDoc[] classes()
Specified by:
classes in interface com.sun.javadoc.RootDoc

classNamed

public com.sun.javadoc.ClassDoc classNamed(String arg0)
Specified by:
classNamed in interface com.sun.javadoc.RootDoc

commentText

public String commentText()
Specified by:
commentText in interface com.sun.javadoc.Doc

compareTo

public int compareTo(Object arg0)
Specified by:
compareTo in interface com.sun.javadoc.Doc
Specified by:
compareTo in interface Comparable<Object>

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()
Specified by:
firstSentenceTags in interface com.sun.javadoc.Doc

getRawCommentText

public String getRawCommentText()
Specified by:
getRawCommentText in interface com.sun.javadoc.Doc

inlineTags

public com.sun.javadoc.Tag[] inlineTags()
Specified by:
inlineTags in interface com.sun.javadoc.Doc

isAnnotationType

public boolean isAnnotationType()
Specified by:
isAnnotationType in interface com.sun.javadoc.Doc

isAnnotationTypeElement

public boolean isAnnotationTypeElement()
Specified by:
isAnnotationTypeElement in interface com.sun.javadoc.Doc

isClass

public boolean isClass()
Specified by:
isClass in interface com.sun.javadoc.Doc

isConstructor

public boolean isConstructor()
Specified by:
isConstructor in interface com.sun.javadoc.Doc

isEnum

public boolean isEnum()
Specified by:
isEnum in interface com.sun.javadoc.Doc

isEnumConstant

public boolean isEnumConstant()
Specified by:
isEnumConstant in interface com.sun.javadoc.Doc

isError

public boolean isError()
Specified by:
isError in interface com.sun.javadoc.Doc

isException

public boolean isException()
Specified by:
isException in interface com.sun.javadoc.Doc

isField

public boolean isField()
Specified by:
isField in interface com.sun.javadoc.Doc

isIncluded

public boolean isIncluded()
Specified by:
isIncluded in interface com.sun.javadoc.Doc

isInterface

public boolean isInterface()
Specified by:
isInterface in interface com.sun.javadoc.Doc

isMethod

public boolean isMethod()
Specified by:
isMethod in interface com.sun.javadoc.Doc

isOrdinaryClass

public boolean isOrdinaryClass()
Specified by:
isOrdinaryClass in interface com.sun.javadoc.Doc

name

public String name()
Specified by:
name in interface com.sun.javadoc.Doc

options

public String[][] options()
Specified by:
options in interface com.sun.javadoc.RootDoc

packageNamed

public com.sun.javadoc.PackageDoc packageNamed(String arg0)
Specified by:
packageNamed in interface com.sun.javadoc.RootDoc

position

public com.sun.javadoc.SourcePosition position()
Specified by:
position in interface com.sun.javadoc.Doc

printError

public void printError(com.sun.javadoc.SourcePosition arg0,
                       String arg1)
Specified by:
printError in interface com.sun.javadoc.DocErrorReporter

printError

public void printError(String arg0)
Specified by:
printError in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(com.sun.javadoc.SourcePosition arg0,
                        String arg1)
Specified by:
printNotice in interface com.sun.javadoc.DocErrorReporter

printNotice

public void printNotice(String arg0)
Specified by:
printNotice in interface com.sun.javadoc.DocErrorReporter

seeTags

public com.sun.javadoc.SeeTag[] seeTags()
Specified by:
seeTags in interface com.sun.javadoc.Doc

setRawCommentText

public void setRawCommentText(String arg0)
Specified by:
setRawCommentText in interface com.sun.javadoc.Doc

specifiedClasses

public com.sun.javadoc.ClassDoc[] specifiedClasses()
Specified by:
specifiedClasses in interface com.sun.javadoc.RootDoc

specifiedPackages

public com.sun.javadoc.PackageDoc[] specifiedPackages()
Specified by:
specifiedPackages in interface com.sun.javadoc.RootDoc

tags

public com.sun.javadoc.Tag[] tags()
Specified by:
tags in interface com.sun.javadoc.Doc

tags

public com.sun.javadoc.Tag[] tags(String arg0)
Specified by:
tags in interface com.sun.javadoc.Doc


Copyright © 2008-2012 JBoss - a division of Red Hat. All Rights Reserved.