SourceCache

java.lang.Object
- com.oracle.svm.hosted.image.sources.SourceCache

```
public class SourceCache
extends Object
```
An abstract cache manager for some subspace of the JDK, GraalVM or application source file space. This class implements core behaviours that manage a cache of source files in a specific subdirectory of the local sources directory. It allows source files to be located when present in the local cache or cached when not already present. Subclasses are responsible for providing behaviours that identify an original source for addition to the cache and for verifying that a cached file is not out of date with respect to its original.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SourceCache.SourceCacheFeature` An automatic feature class which acquires the image loader class path via the afterAnalysis callback.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static List<Path>`	`classPathEntries` A list of all entries in the classpath used by the native image classloader.
`protected static List<String>`	`sourcePathEntries` A list of all entries in the classpath used by the native image classloader.
`protected List<com.oracle.svm.hosted.image.sources.SourceRoot>`	`srcRoots` A list of root directories which may contain source files from which this cache can be populated.

Constructor Summary

Constructors
Modifier Constructor and Description

protected SourceCache()
Create the source cache.

Constructors
Modifier	Constructor and Description
`protected`	`SourceCache()` Create the source cache.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addApplicationSourceRoot(Path sourceRoot, boolean fromClassPath)`
`protected File`	`cachedFile(Path candidate)` Convert a potential resolved candidate path to the corresponding local File in this cache.
`protected Path`	`cachedPath(Path candidate)` Convert a potential resolved candidate path to the corresponding local Path in this cache.
`protected Path`	`checkCacheFile(Path filePath, Class<?> clazz)` Check whether the copy of a given source file in the local source cache is up to date with respect to any original located in this cache's and if not copy the original to the subdirectory that belongs to this cache.
`protected static boolean`	`checkSourcePath(Path sourcePath)` Indicate whether a source path identifies a file in the associated file system.
`protected static void`	`ensureTargetDirs(Path targetDir)` Ensure the directory hierarchy for a path exists creating any missing directories if needed.
`protected Path`	`extendPath(Path root, Path filePath)` Extend a root path form one file system using a path potentially derived from another file system by converting he latter to a text string and replacing the file separator if necessary.
`File`	`findCandidate(Path filePath)` Given a prototype path for a file to be resolved return a File identifying a cached candidate for for that Path or null if no cached candidate exists.
`Path`	`resolve(Path filePath, Class<?> clazz)` Cache the source file identified by the supplied prototype path if a legitimate candidate for inclusion in this cache can be identified and is not yet included in the cache or alternatively identify and validate any existing candidate cache entry to ensure it is not out of date refreshing it if need be.
`protected Path`	`tryCacheFile(Path filePath, Class<?> clazz)` Attempt to copy a source file from one of this cache's source roots to the local sources directory storing it in the subdirectory that belongs to this cache.
`protected boolean`	`tryCacheFileFromRoot(Path sourcePath, Path targetPath)`
`protected boolean`	`tryCheckCacheFile(Path sourcePath, Path targetPath)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - classPathEntries
```
protected static final List<Path> classPathEntries
```
    A list of all entries in the classpath used by the native image classloader.
  - sourcePathEntries
```
protected static final List<String> sourcePathEntries
```
    A list of all entries in the classpath used by the native image classloader.
  - srcRoots
```
protected List<com.oracle.svm.hosted.image.sources.SourceRoot> srcRoots
```
    A list of root directories which may contain source files from which this cache can be populated.
- Constructor Detail
  - SourceCache
```
protected SourceCache()
```
    Create the source cache.
- Method Detail
  - addApplicationSourceRoot
```
protected void addApplicationSourceRoot(Path sourceRoot,
                                        boolean fromClassPath)
```
  - resolve
```
public Path resolve(Path filePath,
                    Class<?> clazz)
```
    Cache the source file identified by the supplied prototype path if a legitimate candidate for inclusion in this cache can be identified and is not yet included in the cache or alternatively identify and validate any existing candidate cache entry to ensure it is not out of date refreshing it if need be.
    
    Parameters:
    
    filePath - a prototype path for a file to be included in the cache derived from the name of some associated class.
    
    Returns:
    
    a path identifying the cached file or null if the candidate cannot be found.
  - findCandidate
```
public File findCandidate(Path filePath)
```
    Given a prototype path for a file to be resolved return a File identifying a cached candidate for for that Path or null if no cached candidate exists.
    
    Parameters:
    
    filePath - a prototype path for a file to be included in the cache derived from the name of some associated class.
    
    Returns:
    
    a File identifying a cached candidate or null.
  - tryCacheFile
```
protected Path tryCacheFile(Path filePath,
                            Class<?> clazz)
```
    Attempt to copy a source file from one of this cache's source roots to the local sources directory storing it in the subdirectory that belongs to this cache.
    
    Parameters:
    
    filePath - a path appended to each of the cache's source roots in turn until an acceptable source file is found and copied to the local source directory.
    
    Returns:
    
    the supplied path if the file has been located and copied to the local sources directory or null if it was not found or the copy failed.
  - tryCacheFileFromRoot
```
protected boolean tryCacheFileFromRoot(Path sourcePath,
                                       Path targetPath)
```
  - checkCacheFile
```
protected Path checkCacheFile(Path filePath,
                              Class<?> clazz)
```
    Check whether the copy of a given source file in the local source cache is up to date with respect to any original located in this cache's and if not copy the original to the subdirectory that belongs to this cache.
    
    Parameters:
    
    filePath - a path appended to each of the cache's source roots in turn until an matching original source is found for comparison against the local source directory.
    
    Returns:
    
    the supplied path if the file is up to date or if an updated version has been copied to the local sources directory or null if was not found or the copy failed.
  - tryCheckCacheFile
```
protected boolean tryCheckCacheFile(Path sourcePath,
                                    Path targetPath)
                             throws IOException
```
    Throws:
    
    IOException
  - extendPath
```
protected Path extendPath(Path root,
                          Path filePath)
```
    Extend a root path form one file system using a path potentially derived from another file system by converting he latter to a text string and replacing the file separator if necessary.
    
    Parameters:
    
    root - the path to be extended
    
    filePath - the subpath to extend it with
    
    Returns:
    
    the extended path
  - cachedPath
```
protected Path cachedPath(Path candidate)
```
    Convert a potential resolved candidate path to the corresponding local Path in this cache.
    
    Parameters:
    
    candidate - a resolved candidate path for some given resolution request
    
    Returns:
    
    the corresponding local Path
  - cachedFile
```
protected File cachedFile(Path candidate)
```
    Convert a potential resolved candidate path to the corresponding local File in this cache.
    
    Parameters:
    
    candidate - a resolved candidate path for some given resolution request
    
    Returns:
    
    the corresponding local File
  - checkSourcePath
```
protected static boolean checkSourcePath(Path sourcePath)
```
    Indicate whether a source path identifies a file in the associated file system.
    
    Parameters:
    
    sourcePath - the path to check
    
    Returns:
    
    true if the path identifies a file or false if no such file can be found.
  - ensureTargetDirs
```
protected static void ensureTargetDirs(Path targetDir)
```
    Ensure the directory hierarchy for a path exists creating any missing directories if needed.
    
    Parameters:
    
    targetDir - a path to the desired directory

Class SourceCache

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

classPathEntries

sourcePathEntries

srcRoots

Constructor Detail

SourceCache

Method Detail

addApplicationSourceRoot

resolve

findCandidate

tryCacheFile

tryCacheFileFromRoot

checkCacheFile

tryCheckCacheFile

extendPath

cachedPath

cachedFile

checkSourcePath

ensureTargetDirs