public interface JamServiceParams
Used to specify the parameters with which a JamService will be created.
Modifier and Type | Method and Description |
---|---|
void |
addClassBuilder(JamClassBuilder cb)
Adds a custom JamClassBuilder which will be consulted by the
JamClassLoader when constructing representation of java types.
|
void |
addClassLoader(ClassLoader cl)
DOCME
|
void |
addClasspath(File classpathElement)
Adds an elements to the JamService classpath.
|
void |
addInitializer(MVisitor initializer) |
void |
addSourcepath(File sourcepathElement)
Adds an elements to the JamService sourcepath.
|
void |
addToolClasspath(File classpathElement)
Adds an elements to the tool classpath.
|
void |
excludeClass(String qualifiedClassname)
Names a specific class to be excluded in the JamService.
|
void |
excludeClassFile(File[] sourcepath,
File sourceFile)
Excludes a single class File in the JamService in exactly the same
way theat includeSourceFile() includes a source file.
|
void |
excludeClassPattern(File[] classpath,
String pattern)
Specifies a set of java class files to be excluded from the JamService.
|
void |
excludeSourceFile(File[] sourcepath,
File sourceFile)
Excludes a single source File in the JamService in exactly the same
way theat includeSourceFile() includes a source file.
|
void |
excludeSourcePattern(File[] sourcepath,
String pattern)
Specifies a set of java source files to be excluded in the JamService.
|
void |
includeClass(String qualifiedClassname)
Names a specific class to be included in the JamService.
|
void |
includeClassFile(File[] sourcepath,
File sourceFile)
Includes a single class File in the JamService in exactly the same
way theat includeSourceFile() includes a source file.
|
void |
includeClassPattern(File[] classpath,
String pattern)
Specifies a set of java class files to be excluded in the JamService.
|
void |
includeSourceFile(File file)
Include a single java source file to be viewed.
|
void |
includeSourceFile(File[] sourcepath,
File sourceFile)
Includes a single source File in the JamService.
|
void |
includeSourcePattern(File[] sourcepath,
String pattern)
Specifies a set of java source files to be included in the JamService.
|
void |
set14WarningsEnabled(boolean b)
Sets whether warnings should be displayed when running under
JDK 1.4.
|
void |
setJamLogger(JamLogger logger)
Sets the JamLogger which will receive error and warning messages from
JAM.
|
void |
setJavadocTagParser(JavadocTagParser tp) |
void |
setLoggerWriter(PrintWriter out)
Sets a PrintWriter to which the JamService implementation should log
errors and debugging information.
|
void |
setParentClassLoader(JamClassLoader loader)
Sets the parent JamClassLoader of the service JamClassLoader.
|
void |
setProperty(String name,
String value)
Sets an implementation-specific property.
|
void |
setPropertyInitializer(MVisitor initializer) |
void |
setShowWarnings(boolean b)
Enables or suppresses the logging of warning messages.
|
void |
setUseSystemClasspath(boolean use)
Specifies whether the JAM Service should load classes from the system
classpath.
|
void |
setVerbose(boolean v)
Deprecated.
use setVerbose(Class). This is the same as
setVerbose(Object.class).
|
void |
setVerbose(Class c)
Enables verbose debugging output from all instances of the given
class.
|
void includeSourceFile(File file)
Include a single java source file to be viewed. Note that if your code is able to understand the file/package structure in which the source exists, you may get better performance by using the various include... methods which take a sourcepath parameter.
void includeSourcePattern(File[] sourcepath, String pattern)
Note that calling this method implicitly includes the 'root' in the sourcepath (exactly as if addSourcepath(root) had been called).
sourcepath
- Root directory/ies containing source files.pattern
- A relative file pattern (as described above under
'Include and Exclude Patterns').IllegalArgumentException
- if either argument is null.void excludeSourcePattern(File[] sourcepath, String pattern)
sourcepath
- Root directory of the source files.pattern
- A relative file pattern (as described above under
'Include and Exclude Patterns').IllegalArgumentException
- if either argument is null.void includeClassPattern(File[] classpath, String pattern)
classpath
- Root directory of the source files.pattern
- A relative file pattern (as described above under
'Include and Exclude Patterns').IllegalArgumentException
- if either argument is null.void excludeClassPattern(File[] classpath, String pattern)
classpath
- Root directory of the source files.pattern
- A relative file pattern (as described above under
'Include and Exclude Patterns').IllegalArgumentException
- if either argument is null.void includeSourceFile(File[] sourcepath, File sourceFile)
Includes a single source File in the JamService. The sourcepath parameter should identify the source sourcepath of the java source file; the sourceFile parameter must be under the sourcepath subtree.
For example, if a class "foo.bar.MyClass" is stored in a file "c:/myproject/src/foo/bar/MyClass.java", that class could be included in the service by calling
includeSourceFile(new File("c:/myproject/src"), new File("c:/myproject/src/foo/bar/MyClass.java"));
Note that this equivalent to calling
includeSourceFiles(new File("c:/myproject/src"),"foo/bar/MyClass.java");
If you are calling this method and have more than one sourcepath directory, and do not readily know which is the correct sourcepath for a given source File, you can use the getRootForFile() utility method to determine the correct sourcepath to use.
Note that calling this method implicitly includes the 'sourcepath' in the sourcepath (exactly as if addSourcepath(sourcepath) had been called).
sourcepath
- source sourcepath for the java source filesourceFile
- the java source fileIllegalArgumentException
- if either argument is null or if
sourcepath is not an ancestor of sourceFile in the file system.void excludeSourceFile(File[] sourcepath, File sourceFile)
Excludes a single source File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
void includeClassFile(File[] sourcepath, File sourceFile)
Includes a single class File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
void excludeClassFile(File[] sourcepath, File sourceFile)
Excludes a single class File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
void includeClass(String qualifiedClassname)
qualifiedClassname
- a full-qualified classnameIllegalArgumentException
- if the argument is null or not
a valid classname.void excludeClass(String qualifiedClassname)
qualifiedClassname
- a full-qualified classnameIllegalArgumentException
- if the argument is null or not
a valid classname.void addSourcepath(File sourcepathElement)
void addClasspath(File classpathElement)
classpathElement
- elements of the classpathIllegalArgumentException
- if the argument is nullvoid setLoggerWriter(PrintWriter out)
out
- a PrintWriter to write toIllegalArgumentException
- if the argument is nullvoid setJamLogger(JamLogger logger)
void setVerbose(Class c)
void setShowWarnings(boolean b)
Enables or suppresses the logging of warning messages. By default this is true.
void setParentClassLoader(JamClassLoader loader)
loader
- the parent loaerIllegalArgumentException
- if the argument is nullvoid addToolClasspath(File classpathElement)
Adds an elements to the tool classpath. This is the classpath that will be used by the JamService implementation to find any libraries on which it depends. This classpath is distinct from the service classpath set by addClasspath() in that it has no affect on the input class set - it's only used for finding classes on which JAM itself depends.
classpathElement
- elements of the classpathIllegalArgumentException
- if the argument is nullvoid setPropertyInitializer(MVisitor initializer)
void addInitializer(MVisitor initializer)
void setJavadocTagParser(JavadocTagParser tp)
void setUseSystemClasspath(boolean use)
Specifies whether the JAM Service should load classes from the system classpath. The default for this is true, and you shouldn't set it to false unless you really know what you are doing.
void addClassBuilder(JamClassBuilder cb)
Adds a custom JamClassBuilder which will be consulted by the JamClassLoader when constructing representation of java types. The given class builder will have priority over priority over JAM's default source- and reflection-based ClassBuilders. If this method id called more than once, the extra class builders will be prioritized in the order in which they were added.
void addClassLoader(ClassLoader cl)
void set14WarningsEnabled(boolean b)
Sets whether warnings should be displayed when running under JDK 1.4. The default is true.
void setVerbose(boolean v)
Copyright © 2010 - 2020 Adobe. All Rights Reserved