Package org.apache.xmlbeans.impl.jam.provider

Interface JamServiceContext

  • All Superinterfaces:
    JamLogger
    All Known Implementing Classes:
    JamServiceContextImpl
    public interface JamServiceContext
extends JamLogger

    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).

    • 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

      • 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.

      • is14WarningsEnabled

        boolean is14WarningsEnabled()