API

com.ibm.xml.xapi
Interface XCompilationParameters


public interface XCompilationParameters

Interface for compilation parameter settings. Used when generating precompiled Java classes for an expression, query or stylesheet and when loading precompiled classes using the XCompilationFactory compile and load methods. New compilation parameters objects can be created through the XCompilationFactory newOutputParameters method.

See Also:
XCompilationFactory.newCompilationParameters(String), XCompilationFactory

Method Summary
 ClassLoader getClassLoader()
          Get the class loader.
 String getClassName()
          Get the base class name for the generated classes.
 String getDirectoryName()
          Get the directory name.
 String getPackageName()
          Get the package name for the generated classes.
 void setClassLoader(ClassLoader classLoader)
          Specify the class loader to use when loading the classes.
 void setClassName(String className)
          Specify the base class name to use for the generated class files at compile time or the base class name to search for at load time.
 void setDirectoryName(String directoryName)
          Specify the directory to write the class files to at compile time.
 void setPackageName(String packageName)
          Specify the package name to use for the class files at compile time or the package name to search for at load time.
 

Method Detail

setClassName

void setClassName(String className)
Specify the base class name to use for the generated class files at compile time or the base class name to search for at load time. Must be a valid Java class name. Use setPackageName to set the package name.

Parameters:
className - The class name.
Throws:
NullPointerException - if className is null.
See Also:
setPackageName(String)

getClassName

String getClassName()
Get the base class name for the generated classes.

Returns:
The class name.

setPackageName

void setPackageName(String packageName)
Specify the package name to use for the class files at compile time or the package name to search for at load time. Must be a valid Java package name. If not specified the Java default package is used. Use setClassName to set the class name.

Parameters:
packageName - The package name or null to use the Java default package.
See Also:
setClassName(String)

getPackageName

String getPackageName()
Get the package name for the generated classes.

Returns:
The package name or null if not specified.

setDirectoryName

void setDirectoryName(String directoryName)
Specify the directory to write the class files to at compile time. If not specified, the generated classes will be written to the current working directory. This is a compile time parameter only, at load time the classpath is used to locate the class files.

Parameters:
directoryName - The directory name or null to restore the default.

getDirectoryName

String getDirectoryName()
Get the directory name.

Returns:
The directory name or null if not specified.

setClassLoader

void setClassLoader(ClassLoader classLoader)
Specify the class loader to use when loading the classes. The default is to use the class loader that was used to load the processor. This is a load time parameter only.

Parameters:
classLoader - The class loader or null to restore the default.

getClassLoader

ClassLoader getClassLoader()
Get the class loader.

Returns:
The class loader or null if not specified.

IBM Copyright 2004-2008