org.aspectj.org.eclipse.jdt.internal.core.nd.java

Class NdResourceFile

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.nd.NdStruct

org.aspectj.org.eclipse.jdt.internal.core.nd.NdNode

org.aspectj.org.eclipse.jdt.internal.core.nd.java.NdResourceFile

All Implemented Interfaces:

IDestructable, INdStruct

public class NdResourceFile
extends NdNode

Represents a source of java classes (such as a .jar or .class file).

Field Summary

Fields

Modifier and Type	Field and Description
static FieldShort	FILE_FLAGS
static FieldSearchKey<JavaIndex>	FILENAME
static int	FLG_CORRUPT_ZIP_FILE Flag indicating that this is a corrupted zip file.
static FieldLong	HASHCODE_LAST_SCANNED
static FieldString	JAVA_ROOT
static FieldLong	JDK_LEVEL
static FieldString	MANIFEST_CONTENT
static FieldLong	SIZE_LAST_SCANNED
static FieldLong	TIME_LAST_SCANNED
static FieldLong	TIME_LAST_USED
static StructDef<NdResourceFile>	type
static FieldOneToMany<NdType>	TYPES
static FieldOneToMany<NdWorkspaceLocation>	WORKSPACE_MAPPINGS
static FieldList<NdZipEntry>	ZIP_ENTRIES

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.nd.NdNode

NODE_TYPE

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.nd.NdStruct

address, nd

Constructor Summary

Constructors

Constructor and Description
NdResourceFile(Nd nd)
NdResourceFile(Nd dom, long address)

Method Summary

Modifier and Type	Method and Description
NdZipEntry	addZipEntry(java.lang.String fileName)
void	allocateZipEntries(int expectedNumberOfZipEntries)
java.util.List<IPath>	getAllWorkspaceLocations()
IPath	getAnyOpenWorkspaceLocation(IWorkspaceRoot root)
FileFingerprint	getFingerprint()
IPath	getFirstWorkspaceLocation()
int	getFlags()
long	getJdkLevel()
IString	getLocation()
IString	getManifestContent() Returns the content of the JAR's MANIFEST.MF file, or null if either this isn't a .JAR file or it didn't contain a MANIFEST.MF file.
IString	getPackageFragmentRoot() Returns the absolute path to the java root for this .jar or .class file.
IPath	getPath() Returns a workspace path to this resource if possible and the absolute filesystem location if not.
long	getSizeLastScanned()
long	getTimeLastScanned()
long	getTimeLastUsed()
NdType	getType(int index)
int	getTypeCount()
java.util.List<NdType>	getTypes()
java.util.List<NdWorkspaceLocation>	getWorkspaceMappings()
java.util.List<NdZipEntry>	getZipEntries() Returns the set of all leaf zip entries that are not .class files.
boolean	hasAllFlags(int flags)
boolean	isCorruptedZipFile()
boolean	isDoneIndexing() Returns true iff the indexer has finished writing the contents of this file to the index.
boolean	isInIndex() Determines whether this file is still in the index.
void	markAsInvalid()
void	setFingerprint(FileFingerprint newFingerprint)
void	setFlags(int flags)
void	setJdkLevel(long jdkLevel)
void	setLocation(java.lang.String filename)
void	setManifestContent(char[] newContent) Stores the content of the JAR's MANIFEST.MF file.
void	setPackageFragmentRoot(char[] javaRoot)
void	setTimeLastUsed(long timeLastUsed)
java.lang.String	toString()

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.nd.NdNode

delete, destruct, equals, getAddress, getBindingID, getBit, getByte, getNodeId, getNodeType, hashCode, load, load

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.nd.NdStruct

getDB, getNd

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.core.nd.INdStruct

addressOf

Field Detail

FILENAME

public static final FieldSearchKey<JavaIndex> FILENAME

TYPES

public static final FieldOneToMany<NdType> TYPES

TIME_LAST_USED

public static final FieldLong TIME_LAST_USED

TIME_LAST_SCANNED

public static final FieldLong TIME_LAST_SCANNED

SIZE_LAST_SCANNED

public static final FieldLong SIZE_LAST_SCANNED

HASHCODE_LAST_SCANNED

public static final FieldLong HASHCODE_LAST_SCANNED

WORKSPACE_MAPPINGS

public static final FieldOneToMany<NdWorkspaceLocation> WORKSPACE_MAPPINGS

JAVA_ROOT

public static final FieldString JAVA_ROOT

JDK_LEVEL

public static final FieldLong JDK_LEVEL

ZIP_ENTRIES

public static final FieldList<NdZipEntry> ZIP_ENTRIES

MANIFEST_CONTENT

public static final FieldString MANIFEST_CONTENT

FILE_FLAGS

public static final FieldShort FILE_FLAGS

FLG_CORRUPT_ZIP_FILE

public static final int FLG_CORRUPT_ZIP_FILE

Flag indicating that this is a corrupted zip file.

See Also:

Constant Field Values

type

public static final StructDef<NdResourceFile> type

Constructor Detail

NdResourceFile

public NdResourceFile(Nd dom,
                      long address)

NdResourceFile

public NdResourceFile(Nd nd)

Method Detail

isCorruptedZipFile

public boolean isCorruptedZipFile()

getFlags

public int getFlags()

hasAllFlags

public boolean hasAllFlags(int flags)

setFlags

public void setFlags(int flags)

getZipEntries

public java.util.List<NdZipEntry> getZipEntries()

Returns the set of all leaf zip entries that are not .class files. Does not include non-empty directories or .class files, but will contain all other zip entries from the original jar file. Returns the empty list for non-jar files.

getManifestContent

public IString getManifestContent()

Returns the content of the JAR's MANIFEST.MF file, or null if either this isn't a .JAR file or it didn't contain a MANIFEST.MF file.

setManifestContent

public void setManifestContent(char[] newContent)

Stores the content of the JAR's MANIFEST.MF file. This should only be invoked on resources that correspond to JAR files.

getJdkLevel

public long getJdkLevel()

setJdkLevel

public void setJdkLevel(long jdkLevel)

isInIndex

public boolean isInIndex()

Determines whether this file is still in the index. If a NdResourceFile instance is retained while the database lock is released and reobtained, this method should be invoked to ensure that the NdResourceFile has not been deleted in the meantime.

getAllWorkspaceLocations

public java.util.List<IPath> getAllWorkspaceLocations()

getFirstWorkspaceLocation

public IPath getFirstWorkspaceLocation()

getAnyOpenWorkspaceLocation

public IPath getAnyOpenWorkspaceLocation(IWorkspaceRoot root)

getPath

public IPath getPath()

Returns a workspace path to this resource if possible and the absolute filesystem location if not.

getWorkspaceMappings

public java.util.List<NdWorkspaceLocation> getWorkspaceMappings()

getLocation

public IString getLocation()

setLocation

public void setLocation(java.lang.String filename)

getFingerprint

public FileFingerprint getFingerprint()

isDoneIndexing

public boolean isDoneIndexing()

Returns true iff the indexer has finished writing the contents of this file to the index. Returns false if indexing may still be going on. If this returns false, readers should ignore all contents of this file.

Returns:

true iff the contents of this file are usable

getTimeLastScanned

public long getTimeLastScanned()

getSizeLastScanned

public long getSizeLastScanned()

getTimeLastUsed

public long getTimeLastUsed()

setTimeLastUsed

public void setTimeLastUsed(long timeLastUsed)

setFingerprint

public void setFingerprint(FileFingerprint newFingerprint)

setPackageFragmentRoot

public void setPackageFragmentRoot(char[] javaRoot)

getPackageFragmentRoot

public IString getPackageFragmentRoot()

Returns the absolute path to the java root for this .jar or .class file. If this is a .jar file, it returns its own filename.

markAsInvalid

public void markAsInvalid()

getTypeCount

public int getTypeCount()

getTypes

public java.util.List<NdType> getTypes()

getType

public NdType getType(int index)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

allocateZipEntries

public void allocateZipEntries(int expectedNumberOfZipEntries)

addZipEntry

public NdZipEntry addZipEntry(java.lang.String fileName)