SourceLibrary (QDox 2.0-M9 API)

java.lang.Object
- com.thoughtworks.qdox.library.AbstractClassLibrary
- - com.thoughtworks.qdox.library.SourceLibrary

All Implemented Interfaces:

ClassLibrary, java.io.Serializable

Direct Known Subclasses:

SourceFolderLibrary
```
public class SourceLibrary
extends AbstractClassLibrary
```
This Library will immediately parse the source and keeps its reference to a private context. Once the superclass explicitly asks for an instance if will be moved to the context f the supoerclass. If there's a request to get a certain JavaModel Object from a SourceLibrary, it will check all ancestor SourceLibraries as well.

Since:

2.0

Author:

Robert Scholte

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

SourceLibrary(AbstractClassLibrary parent)
Create a new instance of SourceLibrary and chain it to the parent

Constructors
Constructor	Description
`SourceLibrary(AbstractClassLibrary parent)`	Create a new instance of SourceLibrary and chain it to the parent

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JavaSource`	`addSource(java.io.File file)`	Add a `File` containing java code to this library
`JavaSource`	`addSource(java.io.InputStream stream)`	Add an `InputStream` containing java code to this library
`JavaSource`	`addSource(java.io.Reader reader)`	Add a `Reader` containing java code to this library
`JavaSource`	`addSource(java.net.URL url)`	Add a `URL` containing java code to this library
`protected boolean`	`containsClassReference(java.lang.String name)`	This method is used to detect if there's a match with this classname.
`java.lang.String`	`getEncoding()`
`ErrorHandler`	`getErrorHandler()`
`java.util.Collection<JavaClass>`	`getJavaClasses()`	Get all classes, including those from parent SourceLibraries
`java.util.Collection<JavaPackage>`	`getJavaPackages()`	Get all packages, including those from parent SourceLibraries
`java.util.Collection<JavaSource>`	`getJavaSources()`	Get all sources, including those from parent SourceLibraries
`boolean`	`isDebugLexer()`
`boolean`	`isDebugParser()`
`protected void`	`registerJavaSource(JavaSource source)`
`protected JavaClass`	`resolveJavaClass(java.lang.String name)`	The implementation should check it's sources to see if it can build a JavaClass Model If not, just return null; Once found it will be mapped, so there's no need to keep a reference to this object.
`protected JavaPackage`	`resolveJavaPackage(java.lang.String name)`
`void`	`setDebugLexer(boolean debugLexer)`	Use the Lexer in debug mode
`void`	`setDebugParser(boolean debugParser)`	Use the Parser in debug mode
`void`	`setEncoding(java.lang.String encoding)`	Sets the encoding to use when parsing a URL or InputStreamReader
`void`	`setErrorHandler(ErrorHandler errorHandler)`

Methods inherited from class com.thoughtworks.qdox.library.AbstractClassLibrary
getJavaClass, getJavaClass, getJavaClasses, getJavaModules, getJavaPackage, getJavaPackages, getJavaSources, getModelBuilder, getModelBuilder, getModelBuilderFactory, getModelWriterFactory, hasClassReference, setModelBuilderFactory, setModelWriterFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SourceLibrary
```
public SourceLibrary(AbstractClassLibrary parent)
```
    Create a new instance of SourceLibrary and chain it to the parent
    
    Parameters:
    
    parent - the parent classLibrary
- Method Detail
  - addSource
```
public JavaSource addSource(java.io.Reader reader)
                     throws ParseException
```
    Add a Reader containing java code to this library
    
    Parameters:
    
    reader - a Reader which should contain java code
    
    Returns:
    
    The constructed JavaSource object of this reader
    
    Throws:
    
    ParseException - if this content couldn't be parsed to a JavaModel
  - addSource
```
public JavaSource addSource(java.io.InputStream stream)
                     throws ParseException,
                            java.io.IOException
```
    Add an InputStream containing java code to this library
    
    Parameters:
    
    stream - an InputStream which should contain java code
    
    Returns:
    
    The constructed JavaSource object of this stream
    
    Throws:
    
    ParseException - if this content couldn't be parsed to a JavaModel
    
    java.io.IOException - if an IOException occurs
  - addSource
```
public JavaSource addSource(java.net.URL url)
                     throws ParseException,
                            java.io.IOException
```
    Add a URL containing java code to this library
    
    Parameters:
    
    url - a URL which should contain java code
    
    Returns:
    
    The constructed JavaSource object of this url
    
    Throws:
    
    ParseException - if this content couldn't be parsed to a JavaModel
    
    java.io.IOException - if an IOException occurs
  - addSource
```
public JavaSource addSource(java.io.File file)
                     throws ParseException,
                            java.io.IOException
```
    Add a File containing java code to this library
    
    Parameters:
    
    file - a File which should contain java code
    
    Returns:
    
    The constructed JavaSource object of this file
    
    Throws:
    
    ParseException - if this content couldn't be parsed to a JavaModel
    
    java.io.IOException - if an IOException occurs
  - resolveJavaClass
```
protected JavaClass resolveJavaClass(java.lang.String name)
```
    Description copied from class: AbstractClassLibrary
    
    The implementation should check it's sources to see if it can build a JavaClass Model If not, just return null; Once found it will be mapped, so there's no need to keep a reference to this object.
    
    Specified by:
    
    resolveJavaClass in class AbstractClassLibrary
    
    Parameters:
    
    name - the fully qualified name
    
    Returns:
    
    the resolved JavaClass, otherwise null
  - resolveJavaPackage
```
protected JavaPackage resolveJavaPackage(java.lang.String name)
```
    Specified by:
    
    resolveJavaPackage in class AbstractClassLibrary
  - registerJavaSource
```
protected final void registerJavaSource(JavaSource source)
```
    Parameters:
    
    source - the source, might be null
  - setDebugLexer
```
public final void setDebugLexer(boolean debugLexer)
```
    Use the Lexer in debug mode
    
    Parameters:
    
    debugLexer - the debug logging flag
  - isDebugLexer
```
public final boolean isDebugLexer()
```
  - setDebugParser
```
public final void setDebugParser(boolean debugParser)
```
    Use the Parser in debug mode
    
    Parameters:
    
    debugParser - the debug logging flag
  - isDebugParser
```
public final boolean isDebugParser()
```
  - setEncoding
```
public final void setEncoding(java.lang.String encoding)
```
    Sets the encoding to use when parsing a URL or InputStreamReader
    
    Parameters:
    
    encoding - the source encoding
  - getEncoding
```
public final java.lang.String getEncoding()
```
  - setErrorHandler
```
public final void setErrorHandler(ErrorHandler errorHandler)
```
  - getErrorHandler
```
public final ErrorHandler getErrorHandler()
```
  - getJavaClasses
```
public java.util.Collection<JavaClass> getJavaClasses()
```
    Get all classes, including those from parent SourceLibraries
    
    Specified by:
    
    getJavaClasses in interface ClassLibrary
    
    Overrides:
    
    getJavaClasses in class AbstractClassLibrary
    
    Returns:
    
    all JavaClasses of this ClassLibrary
  - getJavaPackages
```
public java.util.Collection<JavaPackage> getJavaPackages()
```
    Get all packages, including those from parent SourceLibraries
    
    Specified by:
    
    getJavaPackages in interface ClassLibrary
    
    Overrides:
    
    getJavaPackages in class AbstractClassLibrary
    
    Returns:
    
    all JavaPackages of this ClassLibrary
  - getJavaSources
```
public java.util.Collection<JavaSource> getJavaSources()
```
    Get all sources, including those from parent SourceLibraries
    
    Specified by:
    
    getJavaSources in interface ClassLibrary
    
    Overrides:
    
    getJavaSources in class AbstractClassLibrary
    
    Returns:
    
    all JavaSources as a List, never null
  - containsClassReference
```
protected boolean containsClassReference(java.lang.String name)
```
    Description copied from class: AbstractClassLibrary
    
    This method is used to detect if there's a match with this classname. The name could be constructed based on imports and inner class paths.
    
    Specified by:
    
    containsClassReference in class AbstractClassLibrary
    
    Parameters:
    
    name - the fully qualified name of the class
    
    Returns:
    
    true if this ClassLibrary has a reference to this class.

Class SourceLibrary

Constructor Summary

Method Summary

Methods inherited from class com.thoughtworks.qdox.library.AbstractClassLibrary

Methods inherited from class java.lang.Object

Constructor Detail

SourceLibrary

Method Detail

addSource

addSource

addSource

addSource

resolveJavaClass

resolveJavaPackage

registerJavaSource

setDebugLexer

isDebugLexer

setDebugParser

isDebugParser

setEncoding

getEncoding

setErrorHandler

getErrorHandler

getJavaClasses

getJavaPackages

getJavaSources

containsClassReference