Package org.sonar.plugins.python.caching

Class Caching

java.lang.Object

org.sonar.plugins.python.caching.Caching

public class Caching
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_VERSION_KEY
final String	cacheVersion
static final String	CONTENT_HASHES_KEY
static final String	CPD_TOKENS_CACHE_KEY_PREFIX
static final String	CPD_TOKENS_STRING_TABLE_KEY_PREFIX
static final String	EFFECTIVE_FILE_TYPE_CACHE_KEY_PREFIX
static final String	IMPORTS_MAP_CACHE_KEY_PREFIX
static final String	PROJECT_FILES_KEY
static final String	PROJECT_SYMBOL_TABLE_CACHE_KEY_PREFIX
static final String	TEST_SOURCES_CONFIGURED_KEY
static final String	TYPESHED_MODULES_KEY

Constructor Summary

Constructors

Constructor	Description
Caching(CacheContext cacheContext, String cacheVersion)

Method Summary

Modifier and Type	Method	Description
CacheContext	cacheContext()
void	copyFromPrevious(String fileKey)
static String	effectiveFileTypeCacheKey(String key)
static String	fileContentHashCacheKey(String key)
static String	importsMapCacheKey(String key)
boolean	isCacheEnabled()
boolean	isCacheVersionUpToDate()
boolean	isTestSourcesConfiguredUnchanged(boolean current)
static String	projectSymbolTableCacheKey(String key)
org.sonar.api.batch.fs.InputFile.Type	readEffectiveFileType(String fileKey)
byte[]	readFileContentHash(String fileKey)
Set<String>	readFilesList()
Set<String>	readImportMapEntry(String fileKey)
Set<Descriptor>	readProjectLevelSymbolTableEntry(String fileKey)
Set<String>	readTypeshedModules()
void	writeCacheVersion()
void	writeEffectiveFileType(String fileKey, org.sonar.api.batch.fs.InputFile.Type type)
void	writeFileContentHash(String fileKey, byte[] hash)
void	writeFilesList(List<String> mainFiles)
void	writeImportsMapEntry(String fileKey, Set<String> imports)
void	writeProjectLevelSymbolTableEntry(String fileKey, Set<Descriptor> descriptors)
void	writeTestSourcesConfigured(boolean testSourcesConfigured)
void	writeTypeshedModules(Set<String> stubModules)

Methods inherited from class java.lang.Object

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

Field Details

IMPORTS_MAP_CACHE_KEY_PREFIX

public static final String IMPORTS_MAP_CACHE_KEY_PREFIX

See Also:

• Constant Field Values

PROJECT_SYMBOL_TABLE_CACHE_KEY_PREFIX

public static final String PROJECT_SYMBOL_TABLE_CACHE_KEY_PREFIX

See Also:

• Constant Field Values

PROJECT_FILES_KEY

public static final String PROJECT_FILES_KEY

See Also:

• Constant Field Values

CONTENT_HASHES_KEY

public static final String CONTENT_HASHES_KEY

See Also:

• Constant Field Values

TYPESHED_MODULES_KEY

public static final String TYPESHED_MODULES_KEY

See Also:

• Constant Field Values

CACHE_VERSION_KEY

public static final String CACHE_VERSION_KEY

See Also:

• Constant Field Values

CPD_TOKENS_CACHE_KEY_PREFIX

public static final String CPD_TOKENS_CACHE_KEY_PREFIX

See Also:

• Constant Field Values

CPD_TOKENS_STRING_TABLE_KEY_PREFIX

public static final String CPD_TOKENS_STRING_TABLE_KEY_PREFIX

See Also:

• Constant Field Values

EFFECTIVE_FILE_TYPE_CACHE_KEY_PREFIX

public static final String EFFECTIVE_FILE_TYPE_CACHE_KEY_PREFIX

See Also:

• Constant Field Values

TEST_SOURCES_CONFIGURED_KEY

public static final String TEST_SOURCES_CONFIGURED_KEY

See Also:

• Constant Field Values

cacheVersion

public final String cacheVersion

Constructor Details

Caching

public Caching(CacheContext cacheContext,
 String cacheVersion)

Method Details

writeImportsMapEntry

public void writeImportsMapEntry(String fileKey,
 Set<String> imports)

writeFileContentHash

public void writeFileContentHash(String fileKey,
 byte[] hash)

writeFilesList

public void writeFilesList(List<String> mainFiles)

writeTypeshedModules

public void writeTypeshedModules(Set<String> stubModules)

writeCacheVersion

public void writeCacheVersion()

writeProjectLevelSymbolTableEntry

public void writeProjectLevelSymbolTableEntry(String fileKey,
 Set<Descriptor> descriptors)

copyFromPrevious

public void copyFromPrevious(String fileKey)

writeEffectiveFileType

public void writeEffectiveFileType(String fileKey,
 org.sonar.api.batch.fs.InputFile.Type type)

readEffectiveFileType

@CheckForNull
public org.sonar.api.batch.fs.InputFile.Type readEffectiveFileType(String fileKey)

writeTestSourcesConfigured

public void writeTestSourcesConfigured(boolean testSourcesConfigured)

isTestSourcesConfiguredUnchanged

public boolean isTestSourcesConfiguredUnchanged(boolean current)

readProjectLevelSymbolTableEntry

@CheckForNull
public Set<Descriptor> readProjectLevelSymbolTableEntry(String fileKey)

readImportMapEntry

@CheckForNull
public Set<String> readImportMapEntry(String fileKey)

readFileContentHash

public byte[] readFileContentHash(String fileKey)

readFilesList

public Set<String> readFilesList()

readTypeshedModules

public Set<String> readTypeshedModules()

isCacheVersionUpToDate

public boolean isCacheVersionUpToDate()

isCacheEnabled

public boolean isCacheEnabled()

cacheContext

public CacheContext cacheContext()

importsMapCacheKey

public static String importsMapCacheKey(String key)

projectSymbolTableCacheKey

public static String projectSymbolTableCacheKey(String key)

fileContentHashCacheKey

public static String fileContentHashCacheKey(String key)

effectiveFileTypeCacheKey

public static String effectiveFileTypeCacheKey(String key)