JamServiceContextImpl (The Adobe Experience Manager SDK 2020.7.3902.20200716T022312Z-200604)

java.lang.Object
- org.apache.xmlbeans.impl.jam.internal.JamLoggerImpl
- - org.apache.xmlbeans.impl.jam.internal.JamServiceContextImpl

All Implemented Interfaces:

ElementContext, JamServiceParams, JamLogger, JamServiceContext
```
public class JamServiceContextImpl
extends JamLoggerImpl
implements JamServiceContext, JamServiceParams, ElementContext
```
Takes settings from the user (through JamServiceParams) and exposes them to the implementation (through JamServiceContext).

Constructor Summary

Constructors
Constructor and Description

JamServiceContextImpl()

Constructors
Constructor and Description
`JamServiceContextImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClassBuilder(JamClassBuilder builder)` 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.
`AnnotationProxy`	`createAnnotationProxy(String jsr175typename)` Creates an empty appropriate proxy for the given 175 annotation instance.
`void`	`excludeClass(String qualifiedClassname)` Names a specific class to be excluded in the JamService.
`void`	`excludeClassFile(File[] classpath, File classFile)` 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.
`String[]`	`getAllClassnames()` Returns an array containing the qualified names of the classes which are in the Service class set.
`JamClassBuilder`	`getBaseBuilder()`
`JamClassLoader`	`getClassLoader()` Returns the classloader the elements should use for type resolution.
`MVisitor`	`getInitializer()`
`ResourcePath`	`getInputClasspath()`
`ResourcePath`	`getInputSourcepath()`
`JamLogger`	`getLogger()`
`String`	`getProperty(String name)`
`ClassLoader[]`	`getReflectionClassLoaders()`
`File[]`	`getSourceFiles()`
`JavadocTagParser`	`getTagParser()` Returns the JavadocTagParser to be used in processing javadoc tags.
`ResourcePath`	`getToolClasspath()`
`File[]`	`getUnstructuredSourceFiles()`
`void`	`includeClass(String qualifiedClassname)` Names a specific class to be included in the JamService.
`void`	`includeClassFile(File[] classpath, File classFile)` 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.
`boolean`	`is14WarningsEnabled()`
`void`	`set14WarningsEnabled(boolean b)` Sets whether warnings should be displayed when running under JDK 1.4.
`void`	`setClassLoader(JamClassLoader loader)`
`void`	`setCommentInitializer(MVisitor initializer)`
`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`	`setUseSystemClasspath(boolean use)` Specifies whether the JAM Service should load classes from the system classpath.

Methods inherited from class org.apache.xmlbeans.impl.jam.internal.JamLoggerImpl
error, error, isVerbose, isVerbose, isVerbose, setShowWarnings, setVerbose, setVerbose, verbose, verbose, verbose, verbose, warning, warning

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

Methods inherited from interface org.apache.xmlbeans.impl.jam.JamServiceParams
setShowWarnings, setVerbose, setVerbose

Methods inherited from interface org.apache.xmlbeans.impl.jam.provider.JamLogger
error, error, isVerbose, isVerbose, isVerbose, setShowWarnings, setVerbose, verbose, verbose, verbose, verbose, warning, warning

- Constructor Detail
  - JamServiceContextImpl
```
public JamServiceContextImpl()
```
- Method Detail
  - setClassLoader
```
public void setClassLoader(JamClassLoader loader)
```
  - getBaseBuilder
```
public JamClassBuilder getBaseBuilder()
```
    Specified by:
    
    getBaseBuilder in interface JamServiceContext
  - getTagParser
```
public JavadocTagParser getTagParser()
```
    Description copied from interface: JamServiceContext
    
    Returns the JavadocTagParser to be used in processing javadoc tags. This never returns null - if no parser was specified by the user, the default one is used. This method should be used only by JavadocClassBuilder.
    
    Specified by:
    
    getTagParser in interface JamServiceContext
  - getAllClassnames
```
public String[] getAllClassnames()
                          throws IOException
```
    Returns an array containing the qualified names of the classes which are in the Service class set.
    
    Specified by:
    
    getAllClassnames in interface JamServiceContext
    
    Throws:
    
    IOException
  - getLogger
```
public JamLogger getLogger()
```
    Specified by:
    
    getLogger in interface ElementContext
    
    Specified by:
    
    getLogger in interface JamServiceContext
  - getSourceFiles
```
public File[] getSourceFiles()
                      throws IOException
```
    Specified by:
    
    getSourceFiles in interface JamServiceContext
    
    Throws:
    
    IOException
  - getUnstructuredSourceFiles
```
public File[] getUnstructuredSourceFiles()
```
  - getInputClasspath
```
public ResourcePath getInputClasspath()
```
    Specified by:
    
    getInputClasspath in interface JamServiceContext
    
    Returns:
    
    The classpath to be searched when trying to initialize an MClass for a java class which was not in the inputSources or inputClasses, or null.
  - getInputSourcepath
```
public ResourcePath getInputSourcepath()
```
    Specified by:
    
    getInputSourcepath in interface JamServiceContext
    
    Returns:
    
    The sourcepath to be searched when trying to initialize an MClass for a java class which was not in the inputSources or inputClasses, or null.
  - getToolClasspath
```
public ResourcePath getToolClasspath()
```
    Specified by:
    
    getToolClasspath in interface JamServiceContext
    
    Returns:
    
    The classpath to be used in loading external classes on which the service implementation depends, or null. This is not generally needed.
  - getProperty
```
public String getProperty(String name)
```
    Specified by:
    
    getProperty in interface JamServiceContext
    
    Returns:
    
    an implementation-specific property, as specified by JamServiceParams.setProperty().
  - getInitializer
```
public MVisitor getInitializer()
```
    Specified by:
    
    getInitializer in interface JamServiceContext
  - addClassBuilder
```
public void addClassBuilder(JamClassBuilder builder)
```
    Description copied from interface: JamServiceParams
    
    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.
    
    Specified by:
    
    addClassBuilder in interface JamServiceParams
  - setCommentInitializer
```
public void setCommentInitializer(MVisitor initializer)
```
  - setPropertyInitializer
```
public void setPropertyInitializer(MVisitor initializer)
```
    Specified by:
    
    setPropertyInitializer in interface JamServiceParams
  - addInitializer
```
public void addInitializer(MVisitor initializer)
```
    Specified by:
    
    addInitializer in interface JamServiceParams
  - setJavadocTagParser
```
public void setJavadocTagParser(JavadocTagParser tp)
```
    Specified by:
    
    setJavadocTagParser in interface JamServiceParams
  - includeSourceFile
```
public void includeSourceFile(File file)
```
    Description copied from interface: JamServiceParams
    
    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.
    
    Specified by:
    
    includeSourceFile in interface JamServiceParams
  - includeSourcePattern
```
public void includeSourcePattern(File[] sourcepath,
                                 String pattern)
```
    Description copied from interface: JamServiceParams
    
    Specifies a set of java source files to be included in the JamService.
    Note that calling this method implicitly includes the 'root' in the sourcepath (exactly as if addSourcepath(root) had been called).
    
    Specified by:
    
    includeSourcePattern in interface JamServiceParams
    
    Parameters:
    
    sourcepath - Root directory/ies containing source files.
    
    pattern - A relative file pattern (as described above under 'Include and Exclude Patterns').
  - includeClassPattern
```
public void includeClassPattern(File[] classpath,
                                String pattern)
```
    Description copied from interface: JamServiceParams
    
    Specifies a set of java class files to be excluded in the JamService. Note that calling this method implicitly includes the 'classpath' in the classpath (as in a call to addClasspath(classpath)).
    
    Specified by:
    
    includeClassPattern in interface JamServiceParams
    
    Parameters:
    
    classpath - Root directory of the source files.
    
    pattern - A relative file pattern (as described above under 'Include and Exclude Patterns').
  - excludeSourcePattern
```
public void excludeSourcePattern(File[] sourcepath,
                                 String pattern)
```
    Description copied from interface: JamServiceParams
    
    Specifies a set of java source files to be excluded in the JamService. Note that calling this method implicitly includes the 'sourcepath' in the sourcepath (as in a call to addSourcepath(sourcepath)).
    
    Specified by:
    
    excludeSourcePattern in interface JamServiceParams
    
    Parameters:
    
    sourcepath - Root directory of the source files.
    
    pattern - A relative file pattern (as described above under 'Include and Exclude Patterns').
  - excludeClassPattern
```
public void excludeClassPattern(File[] classpath,
                                String pattern)
```
    Description copied from interface: JamServiceParams
    
    Specifies a set of java class files to be excluded from the JamService. Note that calling this method implicitly includes the 'classpath' in the classpath (as in a call to addClasspath(classpath)).
    
    Specified by:
    
    excludeClassPattern in interface JamServiceParams
    
    Parameters:
    
    classpath - Root directory of the source files.
    
    pattern - A relative file pattern (as described above under 'Include and Exclude Patterns').
  - includeSourceFile
```
public void includeSourceFile(File[] sourcepath,
                              File sourceFile)
```
    Description copied from interface: JamServiceParams
    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).
    Specified by:
    
    includeSourceFile in interface JamServiceParams
    
    Parameters:
    
    sourcepath - source sourcepath for the java source file
    
    sourceFile - the java source file
  - excludeSourceFile
```
public void excludeSourceFile(File[] sourcepath,
                              File sourceFile)
```
    Description copied from interface: JamServiceParams
    
    Excludes a single source File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
    
    Specified by:
    
    excludeSourceFile in interface JamServiceParams
  - includeClassFile
```
public void includeClassFile(File[] classpath,
                             File classFile)
```
    Description copied from interface: JamServiceParams
    
    Includes a single class File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
    
    Specified by:
    
    includeClassFile in interface JamServiceParams
  - excludeClassFile
```
public void excludeClassFile(File[] classpath,
                             File classFile)
```
    Description copied from interface: JamServiceParams
    
    Excludes a single class File in the JamService in exactly the same way theat includeSourceFile() includes a source file.
    
    Specified by:
    
    excludeClassFile in interface JamServiceParams
  - includeClass
```
public void includeClass(String qualifiedClassname)
```
    Description copied from interface: JamServiceParams
    
    Names a specific class to be included in the JamService. Note that this will return an 'unresolved' JClass unless a source or class file for the named class is available in the classpath or sourcepath.
    
    Specified by:
    
    includeClass in interface JamServiceParams
    
    Parameters:
    
    qualifiedClassname - a full-qualified classname
  - excludeClass
```
public void excludeClass(String qualifiedClassname)
```
    Description copied from interface: JamServiceParams
    
    Names a specific class to be excluded in the JamService. Note that this will have no affect if the named class cannot be found in the sourcepath or classpath.
    
    Specified by:
    
    excludeClass in interface JamServiceParams
    
    Parameters:
    
    qualifiedClassname - a full-qualified classname
  - addClasspath
```
public void addClasspath(File classpathElement)
```
    Description copied from interface: JamServiceParams
    
    Adds an elements to the JamService classpath. The service's JamClassLoader will search this path to find a .class file on which to base a JClass when requested to load a class that was not included in the service and for which no source could be found in the sourcepath.
    
    Specified by:
    
    addClasspath in interface JamServiceParams
    
    Parameters:
    
    classpathElement - elements of the classpath
  - setLoggerWriter
```
public void setLoggerWriter(PrintWriter out)
```
    Description copied from interface: JamServiceParams
    
    Sets a PrintWriter to which the JamService implementation should log errors and debugging information. If this is never set, all such output will be suppressed.
    
    Specified by:
    
    setLoggerWriter in interface JamServiceParams
    
    Parameters:
    
    out - a PrintWriter to write to
  - setJamLogger
```
public void setJamLogger(JamLogger logger)
```
    Description copied from interface: JamServiceParams
    
    Sets the JamLogger which will receive error and warning messages from JAM.
    
    Specified by:
    
    setJamLogger in interface JamServiceParams
  - addSourcepath
```
public void addSourcepath(File sourcepathElement)
```
    Description copied from interface: JamServiceParams
    
    Adds an elements to the JamService sourcepath. The service's JamClassLoader will search this path to find a .java file on which to base a JClass when requested to load a class that was not included in the service.
    
    Specified by:
    
    addSourcepath in interface JamServiceParams
  - addToolClasspath
```
public void addToolClasspath(File classpathElement)
```
    Description copied from interface: JamServiceParams
    
    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.
    
    Specified by:
    
    addToolClasspath in interface JamServiceParams
    
    Parameters:
    
    classpathElement - elements of the classpath
  - setProperty
```
public void setProperty(String name,
                        String value)
```
    Description copied from interface: JamServiceParams
    
    Sets an implementation-specific property.
    
    Specified by:
    
    setProperty in interface JamServiceParams
  - set14WarningsEnabled
```
public void set14WarningsEnabled(boolean b)
```
    Description copied from interface: JamServiceParams
    
    Sets whether warnings should be displayed when running under JDK 1.4. The default is true.
    
    Specified by:
    
    set14WarningsEnabled in interface JamServiceParams
  - setParentClassLoader
```
public void setParentClassLoader(JamClassLoader loader)
```
    Description copied from interface: JamServiceParams
    
    Sets the parent JamClassLoader of the service JamClassLoader.
    
    Specified by:
    
    setParentClassLoader in interface JamServiceParams
    
    Parameters:
    
    loader - the parent loaer
  - setUseSystemClasspath
```
public void setUseSystemClasspath(boolean use)
```
    Description copied from interface: JamServiceParams
    
    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.
    
    Specified by:
    
    setUseSystemClasspath in interface JamServiceParams
  - addClassLoader
```
public void addClassLoader(ClassLoader cl)
```
    Description copied from interface: JamServiceParams
    
    DOCME
    
    Specified by:
    
    addClassLoader in interface JamServiceParams
  - getReflectionClassLoaders
```
public ClassLoader[] getReflectionClassLoaders()
```
    Specified by:
    
    getReflectionClassLoaders in interface JamServiceContext
  - is14WarningsEnabled
```
public boolean is14WarningsEnabled()
```
    Specified by:
    
    is14WarningsEnabled in interface JamServiceContext
  - getClassLoader
```
public JamClassLoader getClassLoader()
```
    Description copied from interface: ElementContext
    
    Returns the classloader the elements should use for type resolution.
    
    Specified by:
    
    getClassLoader in interface ElementContext
  - createAnnotationProxy
```
public AnnotationProxy createAnnotationProxy(String jsr175typename)
```
    Description copied from interface: ElementContext
    
    Creates an empty appropriate proxy for the given 175 annotation instance.
    
    Specified by:
    
    createAnnotationProxy in interface ElementContext

Class JamServiceContextImpl

Constructor Summary

Method Summary

Methods inherited from class org.apache.xmlbeans.impl.jam.internal.JamLoggerImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.xmlbeans.impl.jam.JamServiceParams

Methods inherited from interface org.apache.xmlbeans.impl.jam.provider.JamLogger

Constructor Detail

JamServiceContextImpl

Method Detail

setClassLoader

getBaseBuilder

getTagParser

getAllClassnames

getLogger

getSourceFiles

getUnstructuredSourceFiles

getInputClasspath

getInputSourcepath

getToolClasspath

getProperty

getInitializer

addClassBuilder

setCommentInitializer

setPropertyInitializer

addInitializer

setJavadocTagParser

includeSourceFile

includeSourcePattern

includeClassPattern

excludeSourcePattern

excludeClassPattern

includeSourceFile

excludeSourceFile

includeClassFile

excludeClassFile

includeClass

excludeClass

addClasspath

setLoggerWriter

setJamLogger

addSourcepath

addToolClasspath

setProperty

set14WarningsEnabled

setParentClassLoader

setUseSystemClasspath

addClassLoader

getReflectionClassLoaders

is14WarningsEnabled

getClassLoader

createAnnotationProxy