public class PackageInfo extends DocInfo implements ContainerInfo
Modifier and Type | Field and Description |
---|---|
static Comparator<PackageInfo> |
comparator |
static String |
DEFAULT_PACKAGE |
Constructor and Description |
---|
PackageInfo(com.sun.javadoc.PackageDoc pkg,
String name,
SourcePositionInfo position) |
PackageInfo(String name) |
PackageInfo(String name,
SourcePositionInfo position) |
Modifier and Type | Method and Description |
---|---|
void |
addClass(ClassInfo cl) |
HashMap<String,ClassInfo> |
allClasses() |
boolean |
checkLevel() |
ClassInfo[] |
enums() |
ClassInfo[] |
errors() |
ClassInfo[] |
exceptions() |
static ClassInfo[] |
filterHidden(ClassInfo[] classes) |
static ClassInfo[] |
filterNonModules(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) |
ClassInfo[] |
modules() |
String |
name() |
ClassInfo[] |
ordinaryClasses() |
ContainerInfo |
parent() |
String |
qualifiedName() |
String |
relativePath()
Returns the relative path that represents this item on a
documentation source.
|
addFederatedReference, comment, getFederatedReferences, getRawCommentText, getSince, htmlPage, isDocOnly, position, setFederatedReferences, setSince
public static final String DEFAULT_PACKAGE
public static final Comparator<PackageInfo> comparator
public PackageInfo(com.sun.javadoc.PackageDoc pkg, String name, SourcePositionInfo position)
public PackageInfo(String name)
public PackageInfo(String name, SourcePositionInfo position)
public boolean isDefinedLocally()
DocInfo
isDefinedLocally
in class DocInfo
public String relativePath()
DocInfo
relativePath
in class DocInfo
public String fullDescriptionFile()
public String fullDescriptionHtmlPage()
public ContainerInfo parent()
public boolean checkLevel()
checkLevel
in interface ContainerInfo
public String name()
public String qualifiedName()
qualifiedName
in interface ContainerInfo
public TagInfo[] inlineTags()
public TagInfo[] firstSentenceTags()
public void makeLink(com.google.clearsilver.jsilver.data.Data data, String base)
public void makeClassLinkListHDF(com.google.clearsilver.jsilver.data.Data data, String base)
public ClassInfo[] getAnnotations()
public ClassInfo[] getInterfaces()
public ClassInfo[] ordinaryClasses()
public ClassInfo[] modules()
public ClassInfo[] enums()
public ClassInfo[] exceptions()
public ClassInfo[] errors()
public void addClass(ClassInfo cl)
public boolean isConsistent(PackageInfo pInfo)
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.