oracle.ide.file

Class FileSetTable

java.lang.Object

oracle.ide.file.FileTable

oracle.ide.file.FileSetTable

All Implemented Interfaces:

FileScope

public abstract class FileSetTable
extends FileTable

Abstract base class for file table implementations based on FileSet.

Since:

11.1.2

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ide.file.FileTable

FileTable.FileChangeImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected FileSet	fileSet The file set for this file table.

Fields inherited from class oracle.ide.file.FileTable

FIRST_VERSION, INVALID_FILE_ID, IS_KAVA_TEST, listeners, LOGGER, REMOVED_VERSION, storage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSetTable(Storage storage, FileSet fileSet)

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	checkInterrupt() Check if the calling thread has been interrupted.
boolean	contains(java.net.URL url) Determine whether this scope contains a URL.
protected java.lang.String	getBaseNameSpaceKey() Get the base namespace key used to store file table data.
abstract java.util.Collection<java.lang.String>	getDirectoryPaths() Get the paths of all directories in this table, relative to the file set root.
abstract java.lang.String	getFileName(int id) Get the name of a file.
abstract java.util.Collection<java.lang.String>	getFilePaths() Get the paths of all files in this table, relative to the file set root.
abstract java.util.Collection<java.lang.String>	getFiles(java.lang.String relativePath) Get the names of all files in a directory.
FileSet	getFileSet() Get the file set for this table.
abstract java.util.Collection<java.net.URL>	getFileUrls(java.lang.String relativePath) Get the URLs of all files in a directory.
abstract java.util.Collection<Pair<java.net.URL,java.lang.Long>>	getFileUrlsAndTimestamps(java.lang.String relativePath)
protected FileSetFilter	getFilter() Get the filter used when refreshing this file table.
static FileSetTable	getInstance(Storage storage, FileSet fileSet) Get the file table for a file set.
abstract java.lang.String	getParentPath(int id) Get the path of the parent directory of a file, relative to the root of this file table.
abstract java.lang.String	getRelativePath(int id) Get the path of a file relative to the root of this file table.
java.lang.String	getRelativePath(java.net.URL url) Get the path of a URL relative to the root of this file table.
java.lang.String	getStorageKey() Get a unique identifier for this file table.
abstract java.util.Collection<java.lang.String>	getSubdirectories(java.lang.String relativePath) Get the names of all subdirectories in a directory.
java.lang.String	toString()
abstract void	visitFiles(FileTableVisitor visitor) Visit the files in this file table.

Methods inherited from class oracle.ide.file.FileTable

activate, activateImpl, addFileChangeListener, adjustTimestamps, deactivate, deactivateImpl, delete, getChangesSince, getFileTable, getFileTables, getId, getLastModified, getLength, getRefreshAutomatically, getRefreshOnStartup, getStorage, getURL, invalidate, invalidateAllJars, invalidateDirectory, invalidateDirectory, invalidateDirectoryImpl, invalidateFile, invalidateFileImpl, invalidateJar, invokeListener, invokeListeners, refresh, refreshDirectory, refreshFile, removeFileChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.file.FileScope

getDirectories, getFiles, locate, refresh, update

Field Detail

fileSet

protected final FileSet fileSet

The file set for this file table.

Constructor Detail

FileSetTable

protected FileSetTable(Storage storage,
            FileSet fileSet)

Method Detail

getInstance

public static FileSetTable getInstance(@NotNull
                       Storage storage,
                       @NotNull
                       FileSet fileSet)

Get the file table for a file set.

Parameters:

storage - the storage where the file table is stored

fileSet - the file set defining which files are in the table

Returns:

the file table

getFileSet

public FileSet getFileSet()

Get the file set for this table.

Returns:

the file set

getRelativePath

public java.lang.String getRelativePath(java.net.URL url)

Description copied from class: FileTable

Get the path of a URL relative to the root of this file table. This does not check for existance of the URL.

Specified by:

getRelativePath in class FileTable

Parameters:

url - the URL

Returns:

the relative path, or null if the URL cannot be made relative to this file table

getRelativePath

public abstract java.lang.String getRelativePath(int id)
                                          throws java.lang.InterruptedException,
                                                 java.io.IOException

Get the path of a file relative to the root of this file table.

Parameters:

id - the file id

Returns:

the path of the file relative to the root of the file table, or null if the ID does not exist in this table

Throws:

java.lang.InterruptedException - if the calling thread is interrupted

java.io.IOException - if the file table could not be read

getParentPath

public abstract java.lang.String getParentPath(int id)
                                        throws java.lang.InterruptedException,
                                               java.io.IOException

Get the path of the parent directory of a file, relative to the root of this file table.

Parameters:

id - the file id

Returns:

the path of the parent directory relative to the root of the file table, or null if the ID does not exist in this table

Throws:

java.lang.InterruptedException - if the calling thread is interrupted

java.io.IOException - if the file table could not be read

getFileName

public abstract java.lang.String getFileName(int id)
                                      throws java.lang.InterruptedException,
                                             java.io.IOException

Get the name of a file.

Parameters:

id - the file id

Returns:

the name of the file, or null if the ID does not exist in this table

Throws:

java.lang.InterruptedException - if the calling thread is interrupted

java.io.IOException - if the file table could not be read

getFilePaths

public abstract java.util.Collection<java.lang.String> getFilePaths()
                                                             throws java.io.IOException,
                                                                    java.lang.InterruptedException

Get the paths of all files in this table, relative to the file set root.

Returns:

the relative paths of all files in the table

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

getDirectoryPaths

public abstract java.util.Collection<java.lang.String> getDirectoryPaths()
                                                                  throws java.io.IOException,
                                                                         java.lang.InterruptedException

Get the paths of all directories in this table, relative to the file set root.

Returns:

the relative paths of all directories in the table

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

getSubdirectories

public abstract java.util.Collection<java.lang.String> getSubdirectories(java.lang.String relativePath)
                                                                  throws java.io.IOException,
                                                                         java.lang.InterruptedException

Get the names of all subdirectories in a directory.

Parameters:

relativePath - the relative path of the directory

Returns:

the names of subdirectories

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

getFiles

public abstract java.util.Collection<java.lang.String> getFiles(java.lang.String relativePath)
                                                         throws java.io.IOException,
                                                                java.lang.InterruptedException

Get the names of all files in a directory.

Parameters:

relativePath - the relative path of the directory

Returns:

the names of files in the directory

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

getFileUrls

public abstract java.util.Collection<java.net.URL> getFileUrls(java.lang.String relativePath)
                                                        throws java.io.IOException,
                                                               java.lang.InterruptedException

Get the URLs of all files in a directory.

Parameters:

relativePath - the relative path of the directory

Returns:

the names of files in the directory

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

getFileUrlsAndTimestamps

public abstract java.util.Collection<Pair<java.net.URL,java.lang.Long>> getFileUrlsAndTimestamps(java.lang.String relativePath)
                                                                                          throws java.io.IOException,
                                                                                                 java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

visitFiles

public abstract void visitFiles(FileTableVisitor visitor)
                         throws java.io.IOException,
                                java.lang.InterruptedException

Visit the files in this file table.

Parameters:

visitor - the visitor

Throws:

java.io.IOException - if the file table could not be read

java.lang.InterruptedException - if the calling thread is interrupted

contains

public boolean contains(java.net.URL url)

Description copied from interface: FileScope

Determine whether this scope contains a URL. This does not check for existance of the URL.

Parameters:

url - the URL

Returns:

true if this scope contains the URL, false otherwise

getStorageKey

public java.lang.String getStorageKey()

Description copied from class: FileTable

Get a unique identifier for this file table. This can be used to store and retrieve information about the files in this table.

Specified by:

getStorageKey in class FileTable

Returns:

the unique identifier for the table

getBaseNameSpaceKey

protected java.lang.String getBaseNameSpaceKey()

Get the base namespace key used to store file table data.

Returns:

the base namespace key

checkInterrupt

protected static void checkInterrupt()
                              throws java.lang.InterruptedException

Check if the calling thread has been interrupted.

Throws:

java.lang.InterruptedException - if the calling thread has been interrupted

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFilter

protected FileSetFilter getFilter()

Get the filter used when refreshing this file table. This is typically the intersection of the file set filter and the global filter.

Returns:

the filter