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

Interface FileSystem.Classpath

All Superinterfaces:

IModulePathEntry

All Known Implementing Classes:

ClasspathDirectory, ClasspathJar, ClasspathJep247, ClasspathJep247Jdk12, ClasspathJmod, ClasspathJrt, ClasspathLocation, ClasspathMultiReleaseJar, ClasspathSourceJar

Enclosing class:

FileSystem

public static interface FileSystem.Classpath
extends IModulePathEntry

A Classpath, even though an IModuleLocation, can represent a plain classpath location too. The FileSystem tells the Classpath whether to behave as a module or regular class path via acceptModule(IModule). Sub types of classpath are responsible for appropriate behavior based on this.

Method Summary

Modifier and Type	Method and Description
void	acceptModule(IModule module) Accepts to represent a module location with the given module description.
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)
java.lang.String	getDestinationPath()
java.util.Collection<java.lang.String>	getModuleNames(java.util.Collection<java.lang.String> limitModules)
java.util.Collection<java.lang.String>	getModuleNames(java.util.Collection<java.lang.String> limitModules, java.util.function.Function<java.lang.String,IModule> getModule)
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?
default boolean	hasCUDeclaringPackage(java.lang.String qualifiedPackageName, java.util.function.Function<CompilationUnit,java.lang.String> pkgNameExtractor)
default boolean	hasModule()
void	initialize() Initialize the entry
boolean	isPackage(java.lang.String qualifiedPackageName, java.lang.String moduleName)
char[]	normalizedPath() Return a normalized path for file based classpath entries.
void	reset() This method resets the environment.

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

getModule, getModule, getModulesDeclaringPackage, hasCompilationUnit, isAutomaticModule, listPackages, servesModule

Method Detail

findTypeNames

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

findClass

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

findClass

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

isPackage

boolean isPackage(java.lang.String qualifiedPackageName,
                  java.lang.String moduleName)

hasModule

default boolean hasModule()

hasCUDeclaringPackage

default boolean hasCUDeclaringPackage(java.lang.String qualifiedPackageName,
                                      java.util.function.Function<CompilationUnit,java.lang.String> pkgNameExtractor)

fetchLinkedJars

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. 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

reset

void reset()

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

normalizedPath

char[] normalizedPath()

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

java.lang.String getPath()

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.

Returns:

the path for file based classpath entries

initialize

void initialize()
         throws java.io.IOException

Initialize the entry

Throws:

java.io.IOException

hasAnnotationFileFor

boolean hasAnnotationFileFor(java.lang.String qualifiedTypeName)

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

Parameters:

qualifiedTypeName - type name in qualified /-separated notation.

acceptModule

void acceptModule(IModule module)

Accepts to represent a module location with the given module description.

Parameters:

module -

getDestinationPath

java.lang.String getDestinationPath()

getModuleNames

java.util.Collection<java.lang.String> getModuleNames(java.util.Collection<java.lang.String> limitModules)

getModuleNames

java.util.Collection<java.lang.String> getModuleNames(java.util.Collection<java.lang.String> limitModules,
                                                      java.util.function.Function<java.lang.String,IModule> getModule)