Package com.thoughtworks.qdox.model
Interface JavaPackage
-
- All Superinterfaces:
JavaAnnotatedElement
,JavaModel
,java.io.Serializable
- All Known Implementing Classes:
DefaultJavaPackage
public interface JavaPackage extends JavaModel, JavaAnnotatedElement
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JavaClass
getClassByName(java.lang.String name)
Try to get any class of this package by name.java.util.Collection<JavaClass>
getClasses()
Returns all the classes found for the package.ClassLibrary
getJavaClassLibrary()
TheClassLibrary
of this package.java.lang.String
getName()
Equivalent ofPackage.getName()
JavaPackage
getParentPackage()
The parent of this package For instance: the package ofjava.lang.reflect
isjava.lang
java.util.Collection<JavaPackage>
getSubPackages()
For instance: one of the children ofjava.lang
would bejava.lang.reflect
java.lang.String
toString()
Equivalent ofPackage.toString()
-
Methods inherited from interface com.thoughtworks.qdox.model.JavaAnnotatedElement
getAnnotations, getComment, getNamedParameter, getTagByName, getTags, getTagsByName
-
Methods inherited from interface com.thoughtworks.qdox.model.JavaModel
getCodeBlock, getLineNumber
-
-
-
-
Method Detail
-
getClasses
java.util.Collection<JavaClass> getClasses()
Returns all the classes found for the package.- Returns:
- all the classes found for the package, never
null
-
getClassByName
JavaClass getClassByName(java.lang.String name)
Try to get any class of this package by name. The name can be both the fully qualified name or just the name of the class.- Parameters:
name
- the (fully qualified) name of the class- Returns:
- the matching class, otherwise
null
- Since:
- 2.0
-
getParentPackage
JavaPackage getParentPackage()
The parent of this package For instance: the package ofjava.lang.reflect
isjava.lang
- Returns:
- the parent package, otherwise
null
-
getSubPackages
java.util.Collection<JavaPackage> getSubPackages()
For instance: one of the children ofjava.lang
would bejava.lang.reflect
- Returns:
- all the children of this package , never
null
-
getName
java.lang.String getName()
Equivalent ofPackage.getName()
- Returns:
- the name, should never be
null
-
getJavaClassLibrary
ClassLibrary getJavaClassLibrary()
TheClassLibrary
of this package.- Returns:
- the classLibrary, should never be
null
-
toString
java.lang.String toString()
Equivalent ofPackage.toString()
- Overrides:
toString
in classjava.lang.Object
- Returns:
- the string representation of the package.
-
-