oracle.jdeveloper.java

Class JavaModelFactory

java.lang.Object

oracle.jdeveloper.java.JavaModelFactory

Direct Known Subclasses:

JdevJavaModelFactory

public class JavaModelFactory
extends java.lang.Object

Defines the interface for creating new environments and locator factories. The default factory creates base implementations. Subclasses should override to be create more complex implementations.

To plug in a new context or new locator factory, make a subclass of JavaModelFactory and then use setInstance(oracle.jdeveloper.java.JavaModelFactory)to set the factory instance used to create new JavaModels.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLocatorFactory	locatorFactory The locator factory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaModelFactory()

Method Summary

Modifier and Type	Method and Description
static JavaModelFactory	getInstance() Gets the JavaModelFactory.
ClassLocatorFactory	getLocatorFactory() Gets the factory we'll use to create new class locators with.
ProviderContext	newContext() Creates a new context for the provider.
protected ProviderContext	newContextImpl() Creates a new context for the provider.
CachedFileProvider	newFileProvider(URLPath sourcepath, URLPath classpath) Create a CachedFileProvider for the given source and class paths.
CachedFileProvider	newFileProvider(URLPath sourcepath, URLPath classpath, URLPath modulepath) Deprecated. Use newFileProvider(URLPath, URLPath) instead. There is no need for a separate module path in a FileProvider since classes are looked up in a combined class and module path.
protected JavaModel	newInstance(CachedFileProvider provider) Creates a new JavaModel instance with the given provider.
JavaModel	newInstance(URLPath sourcepath, URLPath classpath) Creates a new JavaModel instance for the given arguments.
JavaModel	newInstance(URLPath sourcepath, URLPath classpath, URLPath modulepath) Deprecated. Use newInstance(URLPath, URLPath) instead. There is no need for a separate module path in a JavaModel since classes are looked up in a combined class and module path.
protected ClassLocatorFactory	newLocatorFactory() Creates a new locator factory.
static void	setInstance(JavaModelFactory factory) Sets the JavaModelFactory instance to use for creating new JavaModel instances.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locatorFactory

protected ClassLocatorFactory locatorFactory

The locator factory.

Constructor Detail

JavaModelFactory

protected JavaModelFactory()

Method Detail

getInstance

public static JavaModelFactory getInstance()

Gets the JavaModelFactory.

Returns:

Always non-null.

setInstance

public static void setInstance(JavaModelFactory factory)

Sets the JavaModelFactory instance to use for creating new JavaModel instances.

Parameters:

factory - Must be non-null.

newInstance

public final JavaModel newInstance(URLPath sourcepath,
                                   URLPath classpath)

Creates a new JavaModel instance for the given arguments. Note: Jdk paths are NOT implied. They must be explicitly included on the sourcepath and classpath. The source path of the JDK can be retrieved with oracle.jdeveloper.library.JDK#getSourcePath(). The class path of the JDK can be retrieved with oracle.jdeveloper.library.JDK#getClassPath() and will include modules instead of jars for JDK9 and higher. There is no need for a separate module path in a JavaModel since classes are looked up in a combined class and module path.

Parameters:

sourcepath - A source path used to locate sources

classpath - A class path used to locate classes

Returns:

A JavaModel

Throws:

java.lang.IllegalArgumentException - if sourcepath and classpath are both null

newInstance

@Deprecated
public final JavaModel newInstance(URLPath sourcepath,
                                               URLPath classpath,
                                               URLPath modulepath)

Deprecated. Use newInstance(URLPath, URLPath) instead. There is no need for a separate module path in a JavaModel since classes are looked up in a combined class and module path.

newFileProvider

public final CachedFileProvider newFileProvider(URLPath sourcepath,
                                                URLPath classpath)

Create a CachedFileProvider for the given source and class paths. Note: Jdk paths are NOT implied. They must be explicitly included on the sourcepath and classpath. The source path of the JDK can be retrieved with oracle.jdeveloper.library.JDK#getSourcePath(). The class path of the JDK can be retrieved with oracle.jdeveloper.library.JDK#getClassPath() and will include modules instead of jars for JDK9 and higher. There is no need for a separate module path in a JavaModel since classes are looked up in a combined class and module path.

Parameters:

sourcepath - A source path used to locate sources

classpath - A class path used to locate classes

Returns:

A CachedFileProvider

Throws:

java.lang.IllegalArgumentException - if sourcepath and classpath are both null

newFileProvider

public final CachedFileProvider newFileProvider(URLPath sourcepath,
                                                URLPath classpath,
                                                URLPath modulepath)

Deprecated. Use newFileProvider(URLPath, URLPath) instead. There is no need for a separate module path in a FileProvider since classes are looked up in a combined class and module path.

newInstance

protected JavaModel newInstance(CachedFileProvider provider)

Creates a new JavaModel instance with the given provider.

Subclasses should override this if they want to create a JavaModel that is different from the default implementation.

Returns:

A new ProviderEnvironment. Always non-null.

getLocatorFactory

public final ClassLocatorFactory getLocatorFactory()

Gets the factory we'll use to create new class locators with.

Returns:

Always non-null.

newLocatorFactory

protected ClassLocatorFactory newLocatorFactory()

Creates a new locator factory.

Subclasses should override this if they want to create a ClassLocatorFactory that is different from the default implementation.

Returns:

A new ProviderEnvironment. Always non-null.

newContext

public final ProviderContext newContext()

Creates a new context for the provider.

Returns:

A new ProviderEnvironment. Always non-null.

newContextImpl

protected ProviderContext newContextImpl()

Creates a new context for the provider.

Subclasses should override this if they want to create a ProviderEnvironment that is different from the default implementation.

Returns:

A new ProviderEnvironment. Always non-null.