org.aspectj.org.eclipse.jdt.internal.compiler.batch

Class ClasspathJar

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.compiler.batch.ClasspathLocation

org.aspectj.org.eclipse.jdt.internal.compiler.batch.ClasspathJar

All Implemented Interfaces:

FileSystem.Classpath, IModulePathEntry, SuffixConstants

Direct Known Subclasses:

ClasspathJmod, ClasspathMultiReleaseJar, ClasspathSourceJar

public class ClasspathJar
extends ClasspathLocation

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	annotationPaths
protected java.util.zip.ZipFile	annotationZipFile
protected boolean	closeZipFileAtEnd
protected java.io.File	file
protected java.util.Set<java.lang.String>	packageCache
protected java.util.zip.ZipFile	zipFile

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.batch.ClasspathLocation

accessRuleSet, BINARY, destinationPath, SOURCE

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.util.SuffixConstants

EXTENSION_aj, EXTENSION_AJ, EXTENSION_class, EXTENSION_CLASS, EXTENSION_java, EXTENSION_JAVA, EXTENSION_jmod, EXTENSION_JMOD, SUFFIX_aj, SUFFIX_AJ, SUFFIX_class, SUFFIX_CLASS, SUFFIX_java, SUFFIX_JAVA, SUFFIX_STRING_aj, SUFFIX_STRING_AJ, SUFFIX_STRING_class, SUFFIX_STRING_CLASS, SUFFIX_STRING_java, SUFFIX_STRING_JAVA

Constructor Summary

Constructors

Constructor and Description
ClasspathJar(java.io.File file, boolean closeZipFileAtEnd, AccessRuleSet accessRuleSet, java.lang.String destinationPath)

Method Summary

Modifier and Type	Method and Description
protected void	addToPackageCache(java.lang.String fileName, boolean endsWithSep)
void	close()
java.util.List<FileSystem.Classpath>	fetchLinkedJars(FileSystem.ClasspathSectionProblemReporter problemReporter) Return a list of the jar file names defined in the Class-Path section of the jar file manifest if any, null else.
NameEnvironmentAnswer	findClass(char[] typeName, java.lang.String qualifiedPackageName, java.lang.String moduleName, java.lang.String qualifiedBinaryFileName)
NameEnvironmentAnswer	findClass(char[] typeName, java.lang.String qualifiedPackageName, java.lang.String moduleName, java.lang.String qualifiedBinaryFileName, boolean asBinaryOnly)
char[][][]	findTypeNames(java.lang.String qualifiedPackageName, java.lang.String moduleName)
int	getMode()
IModule	getModule() Get the module that this entry contributes.
char[][]	getModulesDeclaringPackage(java.lang.String qualifiedPackageName, java.lang.String moduleName) Answer the relevant modules that declare the given package.
java.lang.String	getPath() Return the path for file based classpath entries.
boolean	hasAnnotationFileFor(java.lang.String qualifiedTypeName) Can the current location provide an external annotation file for the given type?
boolean	hasCompilationUnit(java.lang.String qualifiedPackageName, java.lang.String moduleName) Answer whether the given package has any compilation unit (.java or .class) in the given module.
void	initialize() Initialize the entry
char[][]	listPackages() Lists all packages in this modulepath entry.
char[]	normalizedPath() Return a normalized path for file based classpath entries.
void	reset() This method resets the environment.
java.lang.String	toString()

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.batch.ClasspathLocation

acceptModule, allModules, equals, fetchAccessRestriction, getDestinationPath, getModuleNames, getModuleNames, hashCode, isAutomaticModule, isPackage, selectModules, singletonModuleNameIf

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.compiler.batch.FileSystem.Classpath

hasCUDeclaringPackage, hasModule

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.IModulePathEntry

getModule, servesModule

Field Detail

file

protected java.io.File file

zipFile

protected java.util.zip.ZipFile zipFile

annotationZipFile

protected java.util.zip.ZipFile annotationZipFile

closeZipFileAtEnd

protected boolean closeZipFileAtEnd

packageCache

protected java.util.Set<java.lang.String> packageCache

annotationPaths

protected java.util.List<java.lang.String> annotationPaths

Constructor Detail

ClasspathJar

public ClasspathJar(java.io.File file,
                    boolean closeZipFileAtEnd,
                    AccessRuleSet accessRuleSet,
                    java.lang.String destinationPath)

Method Detail

fetchLinkedJars

public java.util.List<FileSystem.Classpath> fetchLinkedJars(FileSystem.ClasspathSectionProblemReporter problemReporter)

Description copied from interface: FileSystem.Classpath

Return a list of the jar file names defined in the Class-Path section of the jar file manifest if any, null else. Only ClasspathJar (and extending classes) instances may return a non-null result.

Parameters:

problemReporter - problem reporter with which potential misconfiguration issues are raised

Returns:

a list of the jar file names defined in the Class-Path section of the jar file manifest if any

findClass

public NameEnvironmentAnswer findClass(char[] typeName,
                                       java.lang.String qualifiedPackageName,
                                       java.lang.String moduleName,
                                       java.lang.String qualifiedBinaryFileName)

findClass

public NameEnvironmentAnswer findClass(char[] typeName,
                                       java.lang.String qualifiedPackageName,
                                       java.lang.String moduleName,
                                       java.lang.String qualifiedBinaryFileName,
                                       boolean asBinaryOnly)

hasAnnotationFileFor

public boolean hasAnnotationFileFor(java.lang.String qualifiedTypeName)

Description copied from interface: FileSystem.Classpath

Can the current location provide an external annotation file for the given type?

Parameters:

qualifiedTypeName - type name in qualified /-separated notation.

findTypeNames

public char[][][] findTypeNames(java.lang.String qualifiedPackageName,
                                java.lang.String moduleName)

initialize

public void initialize()
                throws java.io.IOException

Description copied from interface: FileSystem.Classpath

Initialize the entry

Throws:

java.io.IOException

addToPackageCache

protected void addToPackageCache(java.lang.String fileName,
                                 boolean endsWithSep)

getModulesDeclaringPackage

public char[][] getModulesDeclaringPackage(java.lang.String qualifiedPackageName,
                                           java.lang.String moduleName)

Description copied from interface: IModulePathEntry

Answer the relevant modules that declare the given package. If moduleName is ModuleBinding.ANY then all packages are relevant, if moduleName is ModuleBinding.UNNAMED, then only packages in the unnamed module are relevant, otherwise consider only packages in the module identified by moduleName.

hasCompilationUnit

public boolean hasCompilationUnit(java.lang.String qualifiedPackageName,
                                  java.lang.String moduleName)

Description copied from interface: IModulePathEntry

Answer whether the given package has any compilation unit (.java or .class) in the given module. For entries representing a single module, the module name should be checked before invoking this method.

Parameters:

qualifiedPackageName - '/'-separated package name

moduleName - if non-null only CUs attached to the given module should be considered

Returns:

true iff a .java or .class file could be found in the given module / package.

listPackages

public char[][] listPackages()

Description copied from interface: IModulePathEntry

Lists all packages in this modulepath entry.

Returns:

array of flat, dot-separated package names

reset

public void reset()

Description copied from interface: FileSystem.Classpath

This method resets the environment. The resulting state is equivalent to a new name environment without creating a new object.

Specified by:

reset in interface FileSystem.Classpath

Overrides:

reset in class ClasspathLocation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

normalizedPath

public char[] normalizedPath()

Description copied from interface: FileSystem.Classpath

Return a normalized path for file based classpath entries. This is an absolute path in which file separators are transformed to the platform-agnostic '/', ending with a '/' for directories. This is an absolute path in which file separators are transformed to the platform-agnostic '/', deprived from the '.jar' (resp. '.zip') extension for jar (resp. zip) files.

Returns:

a normalized path for file based classpath entries

getPath

public java.lang.String getPath()

Description copied from interface: FileSystem.Classpath

Return the path for file based classpath entries. This is an absolute path ending with a file separator for directories, an absolute path including the '.jar' (resp. '.zip') extension for jar (resp. zip) files.

Specified by:

getPath in interface FileSystem.Classpath

Overrides:

getPath in class ClasspathLocation

Returns:

the path for file based classpath entries

getMode

public int getMode()

Overrides:

getMode in class ClasspathLocation

getModule

public IModule getModule()

Description copied from interface: IModulePathEntry

Get the module that this entry contributes. May be null, for instance when this entry does not represent a single module

Returns:

The module that this entry contributes or null

close

public void close()