org.codehaus.jam.provider
Interface JamServiceContext


public interface JamServiceContext

Structure containing information given to a BaseJProvider subclass in order to instantiate a new JStore. This interface is the flip-side of JamServiceParams - it provides a view into the params the user specified. In reality, JamServiceContext and JamServiceParams are implemented by the same object, JamServiceContextImpl, but it is cleaner to separate the users' view of that data (which is write-only) from the provider's view (which is view-only).

Author:
Patrick Calahan <email: pcal-at-bea-dot-com>

Method Summary
 java.lang.String[] getAllClassnames()
           
 JamClassBuilder getBaseBuilder()
           
 java.lang.String getCharacterEncoding()
          Returns the character encoding to be used in reading java source files, or null if the default encoding should be used.
 MVisitor getInitializer()
           
 ResourcePath getInputClasspath()
           
 ResourcePath getInputSourcepath()
           
 JamLogger getLogger()
           
 java.lang.String getProperty(java.lang.String name)
           
 java.lang.ClassLoader[] getReflectionClassLoaders()
           
 java.io.File[] getSourceFiles()
           
 JavadocTagParser getTagParser()
          Returns the JavadocTagParser to be used in processing javadoc tags.
 ResourcePath getToolClasspath()
           
 boolean is14WarningsEnabled()
           
 

Method Detail

getInputClasspath

ResourcePath getInputClasspath()
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

ResourcePath getInputSourcepath()
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

ResourcePath getToolClasspath()
Returns:
The classpath to be used in loading external classes on which the service implementation depends, or null. This is not generally needed.

getProperty

java.lang.String getProperty(java.lang.String name)
Returns:
an implementation-specific property, as specified by JamServiceParams.setProperty().

getInitializer

MVisitor getInitializer()

getReflectionClassLoaders

java.lang.ClassLoader[] getReflectionClassLoaders()

getSourceFiles

java.io.File[] getSourceFiles()
                              throws java.io.IOException
Throws:
java.io.IOException

getAllClassnames

java.lang.String[] getAllClassnames()
                                    throws java.io.IOException
Throws:
java.io.IOException

getLogger

JamLogger getLogger()

getBaseBuilder

JamClassBuilder getBaseBuilder()

getTagParser

JavadocTagParser getTagParser()

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.


getCharacterEncoding

java.lang.String getCharacterEncoding()

Returns the character encoding to be used in reading java source files, or null if the default encoding should be used.


is14WarningsEnabled

boolean is14WarningsEnabled()