Uses a background thread to do the actual I/O and for caching "persistence" so that the caching works faster on repeated activations of the application. The class maintains an in-memory cache, and uses a queue of AsyncCommands to signal to a background thread various actions required to "synchronize" the in-memory cache with the persisted copy. Whenever there is a cache miss from the get(CachedClassReference, byte[]) call, the weaver issues a put(CachedClassEntry, byte[]) call. This call has 2 side-effects:

The in-memory cache is updated so that subsequent calls to get(CachedClassReference, byte[]) will not return the mapped value.
An "update index" AsyncCommand is posted to the background thread so that the newly mapped value will be persisted (eventually)

The actual persistence is implemented by the concrete classes

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	AsynchronousFileCacheBacking.AbstractCommand
public static interface	AsynchronousFileCacheBacking.AsyncCommand Represents an asynchronous command that can be sent to the `AsynchronousFileCacheBacking` instance to be executed on it asynchronously
public static interface	AsynchronousFileCacheBacking.AsynchronousFileCacheBackingCreator<T extends AsynchronousFileCacheBacking>
public static class	AsynchronousFileCacheBacking.ClearCommand
public static class	AsynchronousFileCacheBacking.InsertCommand
public abstract static class	AsynchronousFileCacheBacking.KeyedCommand Base class for `AbstractCommand`s that refer to a cache key
public static class	AsynchronousFileCacheBacking.RemoveCommand
public static class	AsynchronousFileCacheBacking.UpdateIndexCommand

Field Summary

Modifier and Type	Field and Description
protected final Map<String, byte[]>	bytesMap
private static final BlockingQueue<AsynchronousFileCacheBacking.AsyncCommand>	commandsQ
private static Future<?>	commandsRunner
private static final ExecutorService	execService
protected final Map<String, byte[]>	exposedBytes
protected final Map<String, AbstractIndexedFileCacheBacking.IndexEntry>	exposedIndex
protected final Map<String, AbstractIndexedFileCacheBacking.IndexEntry>	index

Inherited from org.aspectj.weaver.tools.cache.AbstractIndexedFileCacheBacking:: EMPTY_INDEX EMPTY_KEYS INDEX_FILE

Constructor Summary

Access	Constructor and Description
protected	AsynchronousFileCacheBacking(File cacheDir)

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements org.aspectj.weaver.tools.cache.CacheBacking.clear. Clear the entire cache
protected static final <T extends AsynchronousFileCacheBacking> T	createBacking(File cacheDir, AsynchronousFileCacheBacking.AsynchronousFileCacheBackingCreator<T> creator)
protected void	executeClearCommand()
protected void	executeCommand(AsynchronousFileCacheBacking.AsyncCommand cmd)
protected void	executeInsertCommand(AsynchronousFileCacheBacking.InsertCommand cmd)
protected void	executeRemoveCommand(AsynchronousFileCacheBacking.RemoveCommand cmd)
protected void	executeUpdateIndexCommand()
public CachedClassEntry	get(CachedClassReference entry to retrieve ref, byte[] Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class originalBytes) Implements org.aspectj.weaver.tools.cache.CacheBacking.get. Get a cache entry
public Map<String, byte[]>	getBytesMap()
protected Map<String, AbstractIndexedFileCacheBacking.IndexEntry>	getIndex() Implements abstract org.aspectj.weaver.tools.cache.AbstractIndexedFileCacheBacking.getIndex.
public List<AbstractIndexedFileCacheBacking.IndexEntry>	getIndexEntries()
public Map<String, AbstractIndexedFileCacheBacking.IndexEntry>	getIndexMap()
public static final boolean	postCacheCommand(AsynchronousFileCacheBacking.AsyncCommand cmd)
public void	put(CachedClassEntry key of the entry entry, byte[] Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class originalBytes) Implements org.aspectj.weaver.tools.cache.CacheBacking.put. Put an entry in the cache
protected abstract Map<String, byte[]>	readClassBytes(Map<String, AbstractIndexedFileCacheBacking.IndexEntry> indexMap, File cacheDir)
public void	remove(CachedClassReference ref) Implements org.aspectj.weaver.tools.cache.CacheBacking.remove. Remove an entry from the cache
protected AbstractIndexedFileCacheBacking.IndexEntry	remove(String key)
protected abstract void	removeClassBytes(String The key representing the class whose bytes are to be removed key) Helper for `executeRemoveCommand(RemoveCommand)`
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.aspectj.weaver.tools.cache.AbstractIndexedFileCacheBacking:: createIndexEntry getIndexFile getKeys readIndex readIndex readIndex resolveIndexMapEntry writeIndex writeIndex writeIndex writeIndex writeIndex

Field Detail

bytesMap	back to summary
protected final Map<String, byte[]> bytesMap

commandsQ	back to summary
private static final BlockingQueue<AsynchronousFileCacheBacking.AsyncCommand> commandsQ

commandsRunner	back to summary
private static Future<?> commandsRunner

execService	back to summary
private static final ExecutorService execService

exposedBytes	back to summary
protected final Map<String, byte[]> exposedBytes

exposedIndex	back to summary
protected final Map<String, AbstractIndexedFileCacheBacking.IndexEntry> exposedIndex

index	back to summary
protected final Map<String, AbstractIndexedFileCacheBacking.IndexEntry> index

Constructor Detail

AsynchronousFileCacheBacking	back to summary
protected AsynchronousFileCacheBacking(File cacheDir)

Method Detail

clear	back to summary
public void clear() Implements org.aspectj.weaver.tools.cache.CacheBacking.clear. Doc from org.aspectj.weaver.tools.cache.CacheBacking.clear. Clear the entire cache

clear

back to summary

public void clear()

Implements org.aspectj.weaver.tools.cache.CacheBacking.clear.

Doc from org.aspectj.weaver.tools.cache.CacheBacking.clear.

Clear the entire cache

createBacking	back to summary
protected static final <T extends AsynchronousFileCacheBacking> T createBacking(File cacheDir, AsynchronousFileCacheBacking.AsynchronousFileCacheBackingCreator<T> creator)

executeClearCommand	back to summary
protected void executeClearCommand() throws Exception

executeCommand	back to summary
protected void executeCommand(AsynchronousFileCacheBacking.AsyncCommand cmd) throws Exception

executeInsertCommand	back to summary
protected void executeInsertCommand(AsynchronousFileCacheBacking.InsertCommand cmd) throws Exception

executeRemoveCommand	back to summary
protected void executeRemoveCommand(AsynchronousFileCacheBacking.RemoveCommand cmd) throws Exception

executeUpdateIndexCommand	back to summary
protected void executeUpdateIndexCommand() throws Exception

get	back to summary
public CachedClassEntry get(CachedClassReference ref, byte[] originalBytes) Implements org.aspectj.weaver.tools.cache.CacheBacking.get. Doc from org.aspectj.weaver.tools.cache.CacheBacking.get. Get a cache entry Parameters ref:CachedClassReference entry to retrieve originalBytes:byte[] Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class Returns:CachedClassEntry the cached bytes or null, if the entry does not exist

get

back to summary

public CachedClassEntry get(CachedClassReference ref, byte[] originalBytes)

Implements org.aspectj.weaver.tools.cache.CacheBacking.get.

Doc from org.aspectj.weaver.tools.cache.CacheBacking.get.

Get a cache entry

Parameters

ref:CachedClassReference: entry to retrieve
originalBytes:byte[]: Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class

Returns:CachedClassEntry

the cached bytes or null, if the entry does not exist

getBytesMap	back to summary
public Map<String, byte[]> getBytesMap()

getIndex	back to summary
protected Map<String, AbstractIndexedFileCacheBacking.IndexEntry> getIndex() Implements abstract org.aspectj.weaver.tools.cache.AbstractIndexedFileCacheBacking.getIndex. Annotations @Override

getIndex

back to summary

protected Map<String, AbstractIndexedFileCacheBacking.IndexEntry> getIndex()

Implements abstract org.aspectj.weaver.tools.cache.AbstractIndexedFileCacheBacking.getIndex.

Annotations

@Override

getIndexEntries	back to summary
public List<AbstractIndexedFileCacheBacking.IndexEntry> getIndexEntries()

getIndexMap	back to summary
public Map<String, AbstractIndexedFileCacheBacking.IndexEntry> getIndexMap()

postCacheCommand	back to summary
public static final boolean postCacheCommand(AsynchronousFileCacheBacking.AsyncCommand cmd)

put	back to summary
public void put(CachedClassEntry entry, byte[] originalBytes) Implements org.aspectj.weaver.tools.cache.CacheBacking.put. Doc from org.aspectj.weaver.tools.cache.CacheBacking.put. Put an entry in the cache Parameters entry:CachedClassEntry key of the entry originalBytes:byte[] Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class

put

back to summary

public void put(CachedClassEntry entry, byte[] originalBytes)

Implements org.aspectj.weaver.tools.cache.CacheBacking.put.

Doc from org.aspectj.weaver.tools.cache.CacheBacking.put.

Put an entry in the cache

Parameters

entry:CachedClassEntry: key of the entry
originalBytes:byte[]: Pre-weaving class bytes - required in order to ensure that the cached entry refers to the same original class

readClassBytes	back to summary
protected abstract Map<String, byte[]> readClassBytes(Map<String, AbstractIndexedFileCacheBacking.IndexEntry> indexMap, File cacheDir)

remove	back to summary
public void remove(CachedClassReference ref) Implements org.aspectj.weaver.tools.cache.CacheBacking.remove. Doc from org.aspectj.weaver.tools.cache.CacheBacking.remove. Remove an entry from the cache

remove

back to summary

public void remove(CachedClassReference ref)

Implements org.aspectj.weaver.tools.cache.CacheBacking.remove.

Doc from org.aspectj.weaver.tools.cache.CacheBacking.remove.

Remove an entry from the cache

remove	back to summary
protected AbstractIndexedFileCacheBacking.IndexEntry remove(String key)

removeClassBytes back to summary

removeClassBytes	back to summary
protected abstract void removeClassBytes(String key) throws Exception Helper for `executeRemoveCommand(RemoveCommand)` Parameters key:String The key representing the class whose bytes are to be removed Exceptions Exception: if failed to remove class bytes

protected abstract void removeClassBytes(String key) throws Exception

Helper for executeRemoveCommand(RemoveCommand)

Parameters

key:String: The key representing the class whose bytes are to be removed

Exceptions

Exception:: if failed to remove class bytes

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.aspectj.weaver.tools.cache back to summary

public abstract Class AsynchronousFileCacheBacking.AbstractCommand

Class Inheritance

extends Object
implements AsyncCommand

java.lang.Object
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand

All Implemented Interfaces

org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand

Known Direct Subclasses

org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.ClearCommand, org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.UpdateIndexCommand, org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.KeyedCommand

Field Summary

Modifier and Type	Field and Description
private final AsynchronousFileCacheBacking	cache

Constructor Summary

Access	Constructor and Description
protected	AbstractCommand(AsynchronousFileCacheBacking backing)

Method Summary

Modifier and Type	Method and Description
public final AsynchronousFileCacheBacking	getCache() Implements org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand.getCache.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

cache	back to summary
private final AsynchronousFileCacheBacking cache

Constructor Detail

AbstractCommand	back to summary
protected AbstractCommand(AsynchronousFileCacheBacking backing)

Method Detail

getCache back to summary

getCache	back to summary
public final AsynchronousFileCacheBacking getCache() Implements org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand.getCache. Returns:AsynchronousFileCacheBacking Doc from org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand.getCache. The `AsynchronousFileCacheBacking` on which this command is supposed to be executed

public final AsynchronousFileCacheBacking getCache()

Implements org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand.getCache.

Returns:AsynchronousFileCacheBacking

Doc from org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AsyncCommand.getCache.

The AsynchronousFileCacheBacking on which this command is supposed to be executed

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.aspectj.weaver.tools.cache back to summary

public Interface AsynchronousFileCacheBacking.AsyncCommand

Known Direct Implementers: org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand

Represents an asynchronous command that can be sent to the AsynchronousFileCacheBacking instance to be executed on it asynchronously

Method Summary

Modifier and Type	Method and Description
public AsynchronousFileCacheBacking	Returns: The `AsynchronousFileCacheBacking` on which this command is supposed to be executed getCache()

Method Detail

getCache	back to summary
public AsynchronousFileCacheBacking getCache() Returns:AsynchronousFileCacheBacking The `AsynchronousFileCacheBacking` on which this command is supposed to be executed See Also `AsynchronousFileCacheBacking#executeCommand(AsyncCommand)`

org.aspectj.weaver.tools.cache back to summary

public Interface AsynchronousFileCacheBacking.AsynchronousFileCacheBackingCreator<T extends org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking>

Method Summary

Modifier and Type	Method and Description
public T	create(File cacheDir)

Method Detail

create	back to summary
public T create(File cacheDir)

org.aspectj.weaver.tools.cache back to summary

public Class AsynchronousFileCacheBacking.ClearCommand

Class Inheritance

extends AbstractCommand

java.lang.Object
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.ClearCommand

Constructor Summary

Access	Constructor and Description
public	ClearCommand(AsynchronousFileCacheBacking cache)

Method Summary

Inherited from org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand:: getCache toString

Constructor Detail

ClearCommand	back to summary
public ClearCommand(AsynchronousFileCacheBacking cache)

org.aspectj.weaver.tools.cache back to summary

public Class AsynchronousFileCacheBacking.InsertCommand

Class Inheritance

extends KeyedCommand

java.lang.Object
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.KeyedCommand
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.InsertCommand

Field Summary

Modifier and Type	Field and Description
private final byte[]	bytes

Constructor Summary

Access	Constructor and Description
public	InsertCommand(AsynchronousFileCacheBacking cache, String keyValue, byte[] classBytes)

Method Summary

Modifier and Type	Method and Description
public final byte[]	getClassBytes()

Inherited from org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.KeyedCommand:: getKey toString

Field Detail

bytes	back to summary
private final byte[] bytes

Constructor Detail

InsertCommand	back to summary
public InsertCommand(AsynchronousFileCacheBacking cache, String keyValue, byte[] classBytes)

Method Detail

getClassBytes	back to summary
public final byte[] getClassBytes()

org.aspectj.weaver.tools.cache back to summary

public abstract Class AsynchronousFileCacheBacking.KeyedCommand

Class Inheritance

extends AbstractCommand

java.lang.Object
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand
org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.KeyedCommand

Known Direct Subclasses

org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.RemoveCommand, org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.InsertCommand

Base class for AbstractCommands that refer to a cache key

Field Summary

Modifier and Type	Field and Description
private final String	key

Constructor Summary

Access	Constructor and Description
protected	KeyedCommand(AsynchronousFileCacheBacking cache, String keyValue)

Method Summary

Modifier and Type	Method and Description
public final String	getKey()
public String	toString() Overrides org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand.toString. Returns a string representation of the object.

Inherited from org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand:: getCache

Field Detail

key	back to summary
private final String key

Constructor Detail

KeyedCommand	back to summary
protected KeyedCommand(AsynchronousFileCacheBacking cache, String keyValue)

Method Detail

getKey	back to summary
public final String getKey()

toString

back to summary

public String toString()

Overrides org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking.AbstractCommand.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public abstract Class AsynchronousFileCacheBacking

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class AsynchronousFileCacheBacking.AbstractCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface AsynchronousFileCacheBacking.AsyncCommand

Method Summary

Method Detail

public Interface AsynchronousFileCacheBacking.AsynchronousFileCacheBackingCreator<T extends org.aspectj.weaver.tools.cache.AsynchronousFileCacheBacking>

Method Summary

Method Detail

public Class AsynchronousFileCacheBacking.ClearCommand

Constructor Summary

Method Summary

Constructor Detail

public Class AsynchronousFileCacheBacking.InsertCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class AsynchronousFileCacheBacking.KeyedCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AsynchronousFileCacheBacking.RemoveCommand

Constructor Summary

Method Summary

Constructor Detail

public Class AsynchronousFileCacheBacking.UpdateIndexCommand

Constructor Summary

Method Summary

Constructor Detail