xsbti.compile

Interface AnalysisStore

All Known Implementing Classes:

AnalysisStore.CachedAnalysisStore, AnalysisStore.SyncedAnalysisStore

public interface AnalysisStore

Defines a store interface that provides analysis read and write capabilities to users. The store is a backend-independent interface that allows implementors to decide how the analysis stores are read and written before or after every incremental compile. The implementations of AnalysisStore live in interfaces extending this one.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnalysisStore.CachedAnalysisStore
static class	AnalysisStore.SyncedAnalysisStore

Method Summary

Modifier and Type	Method and Description
static AnalysisStore	cached(AnalysisStore analysisStore) Returns an analysis store whose last contents are kept in-memory.
java.util.Optional<AnalysisContents>	get() Gets an AnalysisContents from the underlying store.
static AnalysisStore	getCachedStore(AnalysisStore analysisStore) Returns an analysis store whose last contents are kept in-memory.
static AnalysisStore	getThreadSafeStore(AnalysisStore analysisStore) Returns a synchronized analysis store that is thread-safe.
void	set(AnalysisContents analysisContents) Sets an AnalysisContents to the underlying store.
static AnalysisStore	sync(AnalysisStore analysisStore) Returns a synchronized analysis store that is thread-safe.
AnalysisContents	unsafeGet() Gets an AnalysisContents from the underlying store.

Method Detail

getCachedStore

static AnalysisStore getCachedStore(AnalysisStore analysisStore)

Returns an analysis store whose last contents are kept in-memory. There will be only one memory reference to an analysis files. Previous contents will be discarded as set(AnalysisContents) or get() is used.

Parameters:

analysisStore - The underlying analysis store that knows how to read/write contents.

cached

static AnalysisStore cached(AnalysisStore analysisStore)

Returns an analysis store whose last contents are kept in-memory. There will be only one memory reference to an analysis files. Previous contents will be discarded as set(AnalysisContents) or get() is used.

Parameters:

analysisStore - The underlying analysis store that knows how to read/write contents.

getThreadSafeStore

static AnalysisStore getThreadSafeStore(AnalysisStore analysisStore)

Returns a synchronized analysis store that is thread-safe. Thread-safety is achieved by synchronizing in the object.

Parameters:

analysisStore - The underlying analysis store that knows how to read/write contents.

sync

static AnalysisStore sync(AnalysisStore analysisStore)

Returns a synchronized analysis store that is thread-safe. Thread-safety is achieved by synchronizing in the object.

Parameters:

analysisStore - The underlying analysis store that knows how to read/write contents.

get

java.util.Optional<AnalysisContents> get()

Gets an AnalysisContents from the underlying store. The contents of the analysis file are necessary for subsequent incremental compiles given that the analysis files contains information about the previous incremental compile and lets the incremental compiler decide what needs or needs not to be recompiled. This method should be called before every incremental compile.

Returns:

An instance of an optional AnalysisContents, depending on whether if exists or not.

unsafeGet

AnalysisContents unsafeGet()

Gets an AnalysisContents from the underlying store.

set

void set(AnalysisContents analysisContents)

Sets an AnalysisContents to the underlying store. The contents of the analysis file are necessary for subsequent incremental compiles given that the analysis files contains information about the previous incremental compile and lets the incremental compiler decide what needs or needs not to be recompiled. This method is called after every incremental compile.