模块 com.thoughtworks.qdox

程序包 com.thoughtworks.qdox.library

类 OrderedClassLibraryBuilder

java.lang.Object

com.thoughtworks.qdox.library.OrderedClassLibraryBuilder

所有已实现的接口:

ClassLibraryBuilder, Serializable

public class OrderedClassLibraryBuilder
extends Object
implements ClassLibraryBuilder

This library resolves JavaClasses in the order in which class sources are added.

从以下版本开始:

2.0

作者:

Robert Scholte

另请参阅:

• 序列化表格

构造器概要

构造器

构造器	说明
OrderedClassLibraryBuilder()	Default constructor which sets the root classLibrary to ClassNameLibrary.
OrderedClassLibraryBuilder(AbstractClassLibrary rootClassLibrary)	Constructor for which you can set the root ClassLibrary If you set this to null, all classes should be available on the classpath.

方法概要

修饰符和类型	方法	说明
JavaSource	addSource(File file)
JavaSource	addSource(InputStream stream)
JavaSource	addSource(Reader reader)	Add the source content of the reader to the ClassLibrary and return the generated JavaSource
JavaSource	addSource(URL url)
JavaModule	addSourceFolder(File sourceFolder)
ClassLibraryBuilder	appendClassLoader(ClassLoader classLoader)	Append a classloader and return itself
ClassLibraryBuilder	appendDefaultClassLoaders()	Add the defaultClassLoaders and return itse
ClassLibraryBuilder	appendSource(File file)
ClassLibraryBuilder	appendSource(InputStream stream)
ClassLibraryBuilder	appendSource(Reader reader)
ClassLibraryBuilder	appendSource(URL url)
ClassLibraryBuilder	appendSourceFolder(File sourceFolder)
ClassLibrary	getClassLibrary()	Get the library based on the strategy of the implementation
protected final SourceLibrary	getSourceLibrary()
protected ClassLoaderLibrary	newClassLoaderLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of ClassLoaderLibrary
protected SourceFolderLibrary	newSourceFolderLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of SourceFolderLibrary
protected SourceLibrary	newSourceLibrary(AbstractClassLibrary parentLibrary)	Ability to override the implementation of SourceLibrary
ClassLibraryBuilder	setDebugLexer(boolean debugLexer)	Set to true to enable debug logging for the lexer
ClassLibraryBuilder	setDebugParser(boolean debugParser)	Set to true to enable debug logging for the parser
ClassLibraryBuilder	setEncoding(String encoding)
ClassLibraryBuilder	setErrorHander(ErrorHandler errorHandler)	Can handle ParseExceptions instead of crashing.
ClassLibraryBuilder	setModelBuilderFactory(ModelBuilderFactory modelBuilderFactory)	Define the ModelBuilderFactory which the parsers should use to construct the JavaModel Objects
ClassLibraryBuilder	setModelWriterFactory(ModelWriterFactory modelWriterFactory)	Define the ModelWriterFactory which is used by the classes when calling for the codeBlock.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OrderedClassLibraryBuilder

public OrderedClassLibraryBuilder()

Default constructor which sets the root classLibrary to ClassNameLibrary. This way every class will be resolved, even if it's not on the classpath.

OrderedClassLibraryBuilder

public OrderedClassLibraryBuilder(AbstractClassLibrary rootClassLibrary)

Constructor for which you can set the root ClassLibrary If you set this to null, all classes should be available on the classpath.

参数:

rootClassLibrary - the parent Classlibrary

方法详细资料

appendClassLoader

public ClassLibraryBuilder appendClassLoader(ClassLoader classLoader)

从接口复制的说明: ClassLibraryBuilder

Append a classloader and return itself

指定者:

appendClassLoader 在接口中 ClassLibraryBuilder

参数:

classLoader - the classloader to add

返回:

this ClassLibraryBuilder instance

appendDefaultClassLoaders

public ClassLibraryBuilder appendDefaultClassLoaders()

从接口复制的说明: ClassLibraryBuilder

Add the defaultClassLoaders and return itse

指定者:

appendDefaultClassLoaders 在接口中 ClassLibraryBuilder

返回:

this ClassLibraryBuilder instance

appendSourceFolder

public ClassLibraryBuilder appendSourceFolder(File sourceFolder)

指定者:

appendSourceFolder 在接口中 ClassLibraryBuilder

参数:

sourceFolder - the source folder

返回:

this ClassLibraryBuilder instance

appendSource

public ClassLibraryBuilder appendSource(InputStream stream)
                                 throws IOException

指定者:

appendSource 在接口中 ClassLibraryBuilder

参数:

stream - the Java source as stream

返回:

this ClassLibraryBuilder instance

抛出:

IOException - if an IOException is thrown, e.g. unsupported encoding

appendSource

public ClassLibraryBuilder appendSource(Reader reader)

指定者:

appendSource 在接口中 ClassLibraryBuilder

参数:

reader - the Java source as reader

返回:

this ClassLibraryBuilder instance

setDebugLexer

public ClassLibraryBuilder setDebugLexer(boolean debugLexer)

从接口复制的说明: ClassLibraryBuilder

Set to true to enable debug logging for the lexer

指定者:

setDebugLexer 在接口中 ClassLibraryBuilder

参数:

debugLexer - the debug logging flag

返回:

this ClassLibraryBuilder instance

setDebugParser

public ClassLibraryBuilder setDebugParser(boolean debugParser)

从接口复制的说明: ClassLibraryBuilder

Set to true to enable debug logging for the parser

指定者:

setDebugParser 在接口中 ClassLibraryBuilder

参数:

debugParser - the debug logging flag

返回:

this ClassLibraryBuilder instance

setEncoding

public ClassLibraryBuilder setEncoding(String encoding)

指定者:

setEncoding 在接口中 ClassLibraryBuilder

参数:

encoding - set the encoding

返回:

this ClassLibraryBuilder instance

setErrorHander

public ClassLibraryBuilder setErrorHander(ErrorHandler errorHandler)

从接口复制的说明: ClassLibraryBuilder

Can handle ParseExceptions instead of crashing. Has only effect on the appendSource() methods

指定者:

setErrorHander 在接口中 ClassLibraryBuilder

参数:

errorHandler - the errorHandler

返回:

this ClassLibraryBuilder instance

setModelBuilderFactory

public ClassLibraryBuilder setModelBuilderFactory(ModelBuilderFactory modelBuilderFactory)

从接口复制的说明: ClassLibraryBuilder

Define the ModelBuilderFactory which the parsers should use to construct the JavaModel Objects

指定者:

setModelBuilderFactory 在接口中 ClassLibraryBuilder

参数:

modelBuilderFactory - the modelBuilderFactory

返回:

this ClassLibraryBuilder instance

setModelWriterFactory

public ClassLibraryBuilder setModelWriterFactory(ModelWriterFactory modelWriterFactory)

从接口复制的说明: ClassLibraryBuilder

Define the ModelWriterFactory which is used by the classes when calling for the codeBlock.

指定者:

setModelWriterFactory 在接口中 ClassLibraryBuilder

参数:

modelWriterFactory - the modelWriterFactory

返回:

this ClassLibraryBuilder instance

getClassLibrary

public ClassLibrary getClassLibrary()

从接口复制的说明: ClassLibraryBuilder

Get the library based on the strategy of the implementation

指定者:

getClassLibrary 在接口中 ClassLibraryBuilder

返回:

the constructed ClassLibrary

appendSource

public ClassLibraryBuilder appendSource(URL url)
                                 throws IOException

指定者:

appendSource 在接口中 ClassLibraryBuilder

参数:

url - the Java source as URL

返回:

this ClassLibraryBuilder instance

抛出:

IOException - if an IOException occurs

appendSource

public ClassLibraryBuilder appendSource(File file)
                                 throws IOException

指定者:

appendSource 在接口中 ClassLibraryBuilder

参数:

file - the Java source as file

返回:

this ClassLibraryBuilder instance

抛出:

IOException - if an IOException occurs

addSource

public JavaSource addSource(InputStream stream)
                     throws IOException

指定者:

addSource 在接口中 ClassLibraryBuilder

参数:

stream - the Java source as stream

返回:

the created JavaSource

抛出:

IOException - if an IOException is thrown, e.g. unsupported encoding

addSource

public JavaSource addSource(Reader reader)

从接口复制的说明: ClassLibraryBuilder

Add the source content of the reader to the ClassLibrary and return the generated JavaSource

指定者:

addSource 在接口中 ClassLibraryBuilder

参数:

reader - the Java source as reader

返回:

the created JavaSource

addSource

public JavaSource addSource(URL url)
                     throws IOException

指定者:

addSource 在接口中 ClassLibraryBuilder

参数:

url - the Java source as URL

返回:

the created JavaSource

抛出:

IOException - if an IOException occurs

addSource

public JavaSource addSource(File file)
                     throws IOException

指定者:

addSource 在接口中 ClassLibraryBuilder

参数:

file - the Java source as file

返回:

the created JavaSource

抛出:

IOException - if an IOException occurs

addSourceFolder

public JavaModule addSourceFolder(File sourceFolder)

指定者:

addSourceFolder 在接口中 ClassLibraryBuilder

参数:

sourceFolder - the sourcefolder

返回:

the module info if the sourcefolder has a module-info.java, otherwise null

getSourceLibrary

protected final SourceLibrary getSourceLibrary()

newClassLoaderLibrary

protected ClassLoaderLibrary newClassLoaderLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of ClassLoaderLibrary

参数:

parentLibrary - the parent library

返回:

a new ClassLoaderLibrary instance

从以下版本开始:

2.0

newSourceLibrary

protected SourceLibrary newSourceLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of SourceLibrary

参数:

parentLibrary - the parent library

返回:

a new SourceLibrary instance

从以下版本开始:

2.0

newSourceFolderLibrary

protected SourceFolderLibrary newSourceFolderLibrary(AbstractClassLibrary parentLibrary)

Ability to override the implementation of SourceFolderLibrary

参数:

parentLibrary - the parent library

返回:

a new SourceFolderLibrary instance

从以下版本开始:

2.0