com.google.doclava
Class PackageInfo

java.lang.Object
  extended by com.google.doclava.DocInfo
      extended by com.google.doclava.PackageInfo
All Implemented Interfaces:
ContainerInfo

public class PackageInfo
extends DocInfo
implements ContainerInfo


Field Summary
static Comparator<PackageInfo> comparator
           
static String DEFAULT_PACKAGE
           
 
Constructor Summary
PackageInfo(com.sun.javadoc.PackageDoc pkg, String name, SourcePositionInfo position)
           
PackageInfo(String name)
           
PackageInfo(String name, SourcePositionInfo position)
           
 
Method Summary
 void addClass(ClassInfo cl)
           
 HashMap<String,ClassInfo> allClasses()
           
 boolean checkLevel()
           
 ClassInfo[] enums()
           
 ClassInfo[] errors()
           
 ClassInfo[] exceptions()
           
static ClassInfo[] filterHidden(ClassInfo[] classes)
           
 TagInfo[] firstSentenceTags()
           
 String fullDescriptionFile()
           
 String fullDescriptionHtmlPage()
           
 ClassInfo[] getAnnotations()
          Returns the list of annotations defined in this package.
 ClassInfo[] getInterfaces()
           
 int hashCode()
           
 TagInfo[] inlineTags()
           
 boolean isConsistent(PackageInfo pInfo)
           
 boolean isDefinedLocally()
          Returns true if the class represented by this object is defined locally, and thus will be included in local documentation.
 boolean isHidden()
           
 void makeClassLinkListHDF(com.google.clearsilver.jsilver.data.Data data, String base)
           
 void makeLink(com.google.clearsilver.jsilver.data.Data data, String base)
           
 String name()
           
 ClassInfo[] ordinaryClasses()
           
 ContainerInfo parent()
           
 String qualifiedName()
           
 String relativePath()
          Returns the relative path that represents this item on a documentation source.
 
Methods inherited from class com.google.doclava.DocInfo
addFederatedReference, comment, getFederatedReferences, getRawCommentText, getSince, htmlPage, isDocOnly, position, setFederatedReferences, setSince
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_PACKAGE

public static final String DEFAULT_PACKAGE
See Also:
Constant Field Values

comparator

public static final Comparator<PackageInfo> comparator
Constructor Detail

PackageInfo

public PackageInfo(com.sun.javadoc.PackageDoc pkg,
                   String name,
                   SourcePositionInfo position)

PackageInfo

public PackageInfo(String name)

PackageInfo

public PackageInfo(String name,
                   SourcePositionInfo position)
Method Detail

isDefinedLocally

public boolean isDefinedLocally()
Description copied from class: DocInfo
Returns true if the class represented by this object is defined locally, and thus will be included in local documentation.

Specified by:
isDefinedLocally in class DocInfo

relativePath

public String relativePath()
Description copied from class: DocInfo
Returns the relative path that represents this item on a documentation source.

Specified by:
relativePath in class DocInfo

fullDescriptionFile

public String fullDescriptionFile()

fullDescriptionHtmlPage

public String fullDescriptionHtmlPage()

parent

public ContainerInfo parent()
Specified by:
parent in class DocInfo

isHidden

public boolean isHidden()
Overrides:
isHidden in class DocInfo

checkLevel

public boolean checkLevel()
Specified by:
checkLevel in interface ContainerInfo

name

public String name()

qualifiedName

public String qualifiedName()
Specified by:
qualifiedName in interface ContainerInfo

inlineTags

public TagInfo[] inlineTags()

firstSentenceTags

public TagInfo[] firstSentenceTags()

filterHidden

public static ClassInfo[] filterHidden(ClassInfo[] classes)

makeLink

public void makeLink(com.google.clearsilver.jsilver.data.Data data,
                     String base)

makeClassLinkListHDF

public void makeClassLinkListHDF(com.google.clearsilver.jsilver.data.Data data,
                                 String base)

getAnnotations

public ClassInfo[] getAnnotations()
Returns the list of annotations defined in this package.

Returns:

getInterfaces

public ClassInfo[] getInterfaces()

ordinaryClasses

public ClassInfo[] ordinaryClasses()

enums

public ClassInfo[] enums()

exceptions

public ClassInfo[] exceptions()

errors

public ClassInfo[] errors()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

addClass

public void addClass(ClassInfo cl)

allClasses

public HashMap<String,ClassInfo> allClasses()

isConsistent

public boolean isConsistent(PackageInfo pInfo)


Copyright © 2010-2013 Google. All Rights Reserved.