Package com.thoughtworks.qdox.library
Interface ClassLibrary
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractClassLibrary
,ClassLoaderLibrary
,ClassNameLibrary
,SourceFolderLibrary
,SourceLibrary
Main methods of a ClassLibrary, which can be used by every Model
- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptiongetJavaClass
(String name) Get the JavaClass or null if it's not possiblegetJavaClass
(String name, boolean createStub) Try to retrieve the JavaClass by the (binary) name.Return all JavaClasses of the current library.getJavaPackage
(String name) Get the JavaPackage or null if it's not possibleReturn all JavaPackages of the current library.Return all JavaSources of the current library.boolean
hasClassReference
(String name) Check if this library holds a reference based on the name.
-
Method Details
-
hasClassReference
Check if this library holds a reference based on the name.- Parameters:
name
- the (binary) name trying to resolve- Returns:
- true if the classLibrary has a reference, otherwise
false
-
getJavaClass
Get the JavaClass or null if it's not possible- Parameters:
name
- The (binary) name of the JavaClass- Returns:
- the JavaClass, otherwise
null
-
getJavaClass
Try to retrieve the JavaClass by the (binary) name. If the JavaClss doesn't exist and createStub istrue
make a stub, otherwise returnnull
- Parameters:
name
- the name of the classcreateStub
- force creation of a stub if the class can't be found- Returns:
- the JavaClass, might be
null
depending on the value of createStub.
-
getJavaClasses
Collection<JavaClass> getJavaClasses()Return all JavaClasses of the current library. It's up to the library to decide if also collects JavaClasses from it's ancestors- Returns:
- all JavaClasses as a List, never
null
-
getJavaSources
Collection<JavaSource> getJavaSources()Return all JavaSources of the current library. It's up to the library to decide if also collects JavaSources from it's ancestors- Returns:
- all JavaSources as a List, never
null
-
getJavaPackage
Get the JavaPackage or null if it's not possible- Parameters:
name
- The fully qualified name of the JavaPackage- Returns:
- The package, otherwise
null
-
getJavaPackages
Collection<JavaPackage> getJavaPackages()Return all JavaPackages of the current library. It's up to the library to decide if also collects JavaPackages from it's ancestors- Returns:
- all JavaPackages as a List, never
null
-
getJavaModules
Collection<JavaModule> getJavaModules()
-