oracle.jdeveloper.java.provider

Class ProviderContext

java.lang.Object

oracle.jdeveloper.java.provider.ProviderContext

All Implemented Interfaces:

ProviderConstants

Direct Known Subclasses:

JdevProviderContext

public class ProviderContext
extends java.lang.Object
implements ProviderConstants

Defines various aspects of the context for the FileProvider implementations. Subclasses may override various aspects for different behavior.

One aspect is the filesystem interface for creating, getting, and writing SourceFiles. The default implementation reads and writes files directly to the file system.

One aspect is an interface for determining what file type (source file or class file) a particular input URL is. The default implementation checks the file suffix.

One aspect is an interface for retrieving user-defined preferences (mostly related to formatting). The default implementation returns nothing since there are no user-defined preferences in the base implementation.

One aspect is an interface for tracking changes made to a set of URLs. The default implementation does nothing since there is no tracking ability in the base implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CLASS_SUFFIX The default suffix of a Java class file.
protected BaseFileProvider	provider Provider cookie used for new SourceFiles.
protected static java.lang.String	SOURCE_SUFFIX The default suffix of a Java source file.

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

CLASS_TYPE, EMPTY_COLLECTION, SOURCE_TYPE, UNKNOWN_TYPE

Constructor Summary

Constructors

Constructor and Description
ProviderContext()

Method Summary

Modifier and Type	Method and Description
void	clearTracking() Stops all tracking.
SourceFile	createSourceFile(java.net.URL url, int j2se) Deprecated. Use createSourceFile( URL, JdkVersion ) instead
SourceFile	createSourceFile(java.net.URL url, JdkVersion jdkVersion) Creates a new file at the given URL (*.java) and creates a SourceFile object for it.
protected int	getFileType(java.net.URL url)
JavaFile	getLightSourceFile(java.net.URL url, int j2se) Deprecated. Use getLightSourceFile( URL, JdkVersion ) instead
JavaFile	getLightSourceFile(java.net.URL url, JdkVersion jdkVersion) Gets a new "light" SourceFile for the (existing) file at the given URL, packaged as a JavaFile.
BaseFileProvider	getProvider() Get the provider.
protected SourceFile	getSourceFile(TextBuffer textBuffer, int j2se) Deprecated. Use getSourceFile( TextBuffer, JdkVersion ) instead
protected SourceFile	getSourceFile(TextBuffer textBuffer, JdkVersion jdkVersion) Creates a new SourceFile for the given TextBuffer.
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 SourceFile	getSourceFileImpl(java.net.URL url, int j2se) Deprecated. Use getSourceFileImpl( URL, JdkVersion ) instead
protected SourceFile	getSourceFileImpl(java.net.URL url, JdkVersion jdkVersion)
protected SourcePreferences	getSourcePreferences() Gets the user-defined preferences.
protected TextBuffer	getTextBuffer(java.net.URL url) Reads the contents of the given URL into a new TextBuffer.
void	setProvider(BaseFileProvider providerIn) Sets the provider cookie that will be used for new SourceFile instances and will also be notified when URLs have been changed.
protected void	startTracking(java.net.URL url) Starts tracking changes made to the given URL.
boolean	writeSourceFile(SourceFile file) Called when SourceTransaction.commit() is called for the given file.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_SUFFIX

protected static final java.lang.String CLASS_SUFFIX

The default suffix of a Java class file.

See Also:

Constant Field Values

SOURCE_SUFFIX

protected static final java.lang.String SOURCE_SUFFIX

The default suffix of a Java source file.

See Also:

Constant Field Values

provider

protected BaseFileProvider provider

Provider cookie used for new SourceFiles.

Constructor Detail

ProviderContext

public ProviderContext()

Method Detail

setProvider

public void setProvider(BaseFileProvider providerIn)

Sets the provider cookie that will be used for new SourceFile instances and will also be notified when URLs have been changed.

getProvider

public BaseFileProvider getProvider()

Get the provider.

getFileType

protected int getFileType(java.net.URL url)

Returns:

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

getSourcePreferences

protected SourcePreferences getSourcePreferences()

Gets the user-defined preferences.

Returns:

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

createSourceFile

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

Creates a new file at the given URL (*.java) and creates a SourceFile object for it. If the file already exists on disk, then this will return null.

Parameters:

url - 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 url,
                                               int j2se)
                                        throws java.io.IOException,
                                               java.lang.IllegalArgumentException

Deprecated. Use createSourceFile( URL, JdkVersion ) instead

Throws:

java.io.IOException

java.lang.IllegalArgumentException

getSourceFile

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

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

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.

Throws:

java.lang.IllegalArgumentException - if the URL is not recognized as a Java source file, which in this implementation means a .java file.

getSourceFile

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

Deprecated. Use getSourceFile( URL, JdkVersion ) instead

Throws:

java.lang.IllegalArgumentException

getSourceFileImpl

protected SourceFile getSourceFileImpl(java.net.URL url,
                                       JdkVersion jdkVersion)
                                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getSourceFileImpl

@Deprecated
protected SourceFile getSourceFileImpl(java.net.URL url,
                                                   int j2se)
                                            throws java.lang.IllegalArgumentException

Deprecated. Use getSourceFileImpl( URL, JdkVersion ) instead

Throws:

java.lang.IllegalArgumentException

getLightSourceFile

public JavaFile getLightSourceFile(java.net.URL url,
                                   JdkVersion jdkVersion)
                            throws java.lang.IllegalArgumentException

Gets a new "light" SourceFile for the (existing) file at the given URL, packaged as a JavaFile. If no file exists at the given URL, null is returned. A "light" SourceFile is a SourceFile with no information about method bodies. It is useful when the caller only needs to know about fields, method signatures, and inner classes, not about method bodies, since this call triggers a fast parse that skips method bodies.

Parameters:

url - The source URL for which to create a "light" SourceFile

jdkVersion - The desired JdkVersion for the source

Returns:

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

Throws:

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

getLightSourceFile

@Deprecated
public JavaFile getLightSourceFile(java.net.URL url,
                                               int j2se)
                                        throws java.lang.IllegalArgumentException

Deprecated. Use getLightSourceFile( URL, JdkVersion ) instead

Throws:

java.lang.IllegalArgumentException

writeSourceFile

public boolean writeSourceFile(SourceFile file)

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

Returns:

False if an error occurred.

getSourceFile

protected final SourceFile getSourceFile(TextBuffer textBuffer,
                                         JdkVersion jdkVersion)

Creates a new SourceFile for the given TextBuffer.

Parameters:

textBuffer - The text buffer for which to create a SourceFile

jdkVersion - The desired JdkVersion for the source

Returns:

A newly created SourceFile for the given TextBuffer.

getSourceFile

@Deprecated
protected final SourceFile getSourceFile(TextBuffer textBuffer,
                                                     int j2se)

Deprecated. Use getSourceFile( TextBuffer, JdkVersion ) instead

getTextBuffer

protected TextBuffer getTextBuffer(java.net.URL url)
                            throws java.io.FileNotFoundException

Reads the contents of the given URL into a new TextBuffer.

The caller is responsible for checking to see that the file exists before calling.

If any IO exception occurs, null gets returned.

Returns:

A newly created TextBuffer if successful, null otherwise.

Throws:

java.io.FileNotFoundException

startTracking

protected void startTracking(java.net.URL url)

Starts tracking changes made to the given URL.

If a change is made to the given URL, then this should call BaseFileProvider.notifyOfChange(URL).

clearTracking

public void clearTracking()

Stops all tracking.