oracle.jdeveloper.java.provider

Class JdevProviderContext

java.lang.Object

oracle.jdeveloper.java.provider.ProviderContext

oracle.jdeveloper.java.provider.JdevProviderContext

All Implemented Interfaces:

ProviderConstants

public class JdevProviderContext
extends ProviderContext

The BaseFileProvider is an abstract starting point for an implementation of the JavaFileProvider interface that relies on a JavaClassLocator instance for locating Java class and source files.

This implementation contains no caching.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JdevProviderContext.NodeObserver The NodeObserver attaches to nodes for which we have created SourceFile instances for, and tracks the given node until the node is closed, or renamed.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.net.URL,JdevProviderContext.NodeObserver>	_urlToObserverMap The set of URLs that we are currently tracking.
protected static java.lang.Class	JAVACLASSNODE_CLASS The JavaClassNode class instance
protected static java.lang.Class	JAVASOURCENODE_CLASS The JavaSourceNode class instance

Fields inherited from class oracle.jdeveloper.java.provider.ProviderContext

CLASS_SUFFIX, provider, SOURCE_SUFFIX

Fields inherited from interface oracle.jdeveloper.java.provider.ProviderConstants

CLASS_TYPE, EMPTY_COLLECTION, SOURCE_TYPE, UNKNOWN_TYPE

Constructor Summary

Constructors

Constructor and Description
JdevProviderContext(boolean allowInMemoryIn)

Method Summary

Modifier and Type	Method and Description
void	clearTracking() Utility routine to stop tracking all Nodes.
SourceFile	createSourceFile(java.net.URL sourceURL, int j2se) Deprecated. Use createSourceFile( URL, JdkVersion ) instead
SourceFile	createSourceFile(java.net.URL sourceURL, JdkVersion jdkVersion) Instead of directly interacting with the filesystem, use the Ide's Node model.
protected int	getFileType(java.net.URL url) Use the recognizer to check for source files and class files.
SourceFile	getSourceFile(java.net.URL url, int j2se) Deprecated. Use getSourceFile( URL, JdkVersion ) instead
SourceFile	getSourceFile(java.net.URL url, JdkVersion jdkVersion) Gets a new SourceFile for the source file at the given URL.
protected SourcePreferences	getSourcePreferences() Retrieve preferences options from the coding style manager.
protected TextBuffer	getTextBuffer(java.net.URL url) Fetch the TextBuffer for the given URL.
protected void	startTracking(java.net.URL url) Utility routine to start tracking the Node represented by the URL.
protected void	stopTracking(java.net.URL url) Utility routine to stop tracking the Node represented by the URL.
boolean	writeSourceFile(SourceFile file) Called when SourceTransaction.commit() is called for the given file.

Methods inherited from class oracle.jdeveloper.java.provider.ProviderContext

getLightSourceFile, getLightSourceFile, getProvider, getSourceFile, getSourceFile, getSourceFileImpl, getSourceFileImpl, setProvider

Methods inherited from class java.lang.Object

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

Field Detail

JAVACLASSNODE_CLASS

protected static final java.lang.Class JAVACLASSNODE_CLASS

The JavaClassNode class instance

JAVASOURCENODE_CLASS

protected static final java.lang.Class JAVASOURCENODE_CLASS

The JavaSourceNode class instance

_urlToObserverMap

protected java.util.Map<java.net.URL,JdevProviderContext.NodeObserver> _urlToObserverMap

The set of URLs that we are currently tracking.

Constructor Detail

JdevProviderContext

public JdevProviderContext(boolean allowInMemoryIn)

Method Detail

getFileType

protected final int getFileType(java.net.URL url)

Use the recognizer to check for source files and class files.

Overrides:

getFileType in class ProviderContext

Returns:

The type of the URL: CLASS_TYPE, SOURCE_TYPE, or UNKNOWN_TYPE.

getSourcePreferences

protected final SourcePreferences getSourcePreferences()

Retrieve preferences options from the coding style manager.

Overrides:

getSourcePreferences in class ProviderContext

Returns:

The SourcePreferences for user-defined preferences, null if none.

createSourceFile

public SourceFile createSourceFile(java.net.URL sourceURL,
                                   JdkVersion jdkVersion)
                            throws java.io.IOException,
                                   java.lang.IllegalArgumentException

Instead of directly interacting with the filesystem, use the Ide's Node model.

Overrides:

createSourceFile in class ProviderContext

Parameters:

sourceURL - The source URL to create a new Java file for.

jdkVersion - The desired JdkVersion for the source

Returns:

The new source file for the source URL, or null if the file already exists.

Throws:

java.io.IOException - if the new file cannot be created.

java.lang.IllegalArgumentException - if the URL is not recognized as a Java source file.

createSourceFile

@Deprecated
public SourceFile createSourceFile(java.net.URL sourceURL,
                                               int j2se)
                                        throws java.io.IOException,
                                               java.lang.IllegalArgumentException

Deprecated. Use createSourceFile( URL, JdkVersion ) instead

Overrides:

createSourceFile in class ProviderContext

Throws:

java.io.IOException

java.lang.IllegalArgumentException

getSourceFile

public SourceFile getSourceFile(java.net.URL url,
                                JdkVersion jdkVersion)

Description copied from class: ProviderContext

Gets a new SourceFile for the source file at the given URL. If no file exists at the given URL, null is returned.

Overrides:

getSourceFile in class ProviderContext

Parameters:

url - The source URL for which to create a new SourceFile.

jdkVersion - The desired JdkVersion for the source

Returns:

The new SourceFile for the source URL, or null if the file did not exist.

getSourceFile

@Deprecated
public SourceFile getSourceFile(java.net.URL url,
                                            int j2se)

Deprecated. Use getSourceFile( URL, JdkVersion ) instead

Overrides:

getSourceFile in class ProviderContext

writeSourceFile

public boolean writeSourceFile(SourceFile file)

Description copied from class: ProviderContext

Called when SourceTransaction.commit() is called for the given file.

Overrides:

writeSourceFile in class ProviderContext

Returns:

False if an error occurred.

getTextBuffer

protected TextBuffer getTextBuffer(java.net.URL url)

Fetch the TextBuffer for the given URL.

Overrides:

getTextBuffer in class ProviderContext

Returns:

A newly created TextBuffer if successful, null otherwise.

startTracking

protected void startTracking(java.net.URL url)

Utility routine to start tracking the Node represented by the URL.

Overrides:

startTracking in class ProviderContext

stopTracking

protected void stopTracking(java.net.URL url)

Utility routine to stop tracking the Node represented by the URL.

clearTracking

public void clearTracking()

Utility routine to stop tracking all Nodes.

Overrides:

clearTracking in class ProviderContext