Package org.aspectj.org.eclipse.jdt.internal.core.index

Class IndexLocation

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.index.IndexLocation

Direct Known Subclasses:

FileIndexLocation, JarIndexLocation

public abstract class IndexLocation
extends Object

The location of the index files are represented as IndexLocation This is an abstract class to allow different implementation for a jar entry and a file on the disk. Some of these functions could mean different for a jar entry or a file

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	participantIndex	Set to true if this index location is of an index file specified by a participant through SearchParticipant.scheduleDocumentIndexing(org.aspectj.org.eclipse.jdt.core.search.SearchDocument, org.eclipse.core.runtime.IPath)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IndexLocation(File file)
	IndexLocation(URL url)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes any open streams.
static IndexLocation	createIndexLocation(URL url)
abstract boolean	createNewFile()	Creates a new file for the given index location
abstract boolean	delete()
abstract boolean	exists()
abstract String	fileName()
abstract String	getCanonicalFilePath()
abstract File	getIndexFile()
URL	getUrl()
int	hashCode()
boolean	isParticipantIndex()
abstract long	lastModified()
abstract long	length()
abstract boolean	startsWith(org.eclipse.core.runtime.IPath path)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

participantIndex

protected boolean participantIndex

Set to true if this index location is of an index file specified by a participant through SearchParticipant.scheduleDocumentIndexing(org.aspectj.org.eclipse.jdt.core.search.SearchDocument, org.eclipse.core.runtime.IPath)

Constructor Details

IndexLocation

protected IndexLocation(File file)

IndexLocation

public IndexLocation(URL url)

Method Details

createIndexLocation

public static IndexLocation createIndexLocation(URL url)

close

public void close()

Closes any open streams.

createNewFile

public abstract boolean createNewFile()
                               throws IOException

Creates a new file for the given index location

Returns:

true if the file is created

Throws:

IOException

delete

public abstract boolean delete()

exists

public abstract boolean exists()

fileName

public abstract String fileName()

getCanonicalFilePath

public abstract String getCanonicalFilePath()

Returns:

the canonical file path if the location is a file or null otherwise

getIndexFile

public abstract File getIndexFile()

getUrl

public URL getUrl()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isParticipantIndex

public boolean isParticipantIndex()

lastModified

public abstract long lastModified()

Returns:

the last modified time if the location is a file or -1 otherwise

length

public abstract long length()

Returns:

the length of the file if the location is a file or -1 otherwise

startsWith

public abstract boolean startsWith(org.eclipse.core.runtime.IPath path)

toString

public String toString()

Overrides:

toString in class Object