SerializableCache (biojava 6.1.0 API)

java.lang.Object
- org.biojava.nbio.structure.domain.SerializableCache<K,V>

Type Parameters:

K - The key type of the cache

V - the value type to be stored on the cache
```
public class SerializableCache<K,V>
extends Object
```
A class that provides all that is necessary to create a Serializable Cache

Since:

3.0.3

Author:

Andreas Prlic

Field Summary

Fields
Modifier and Type Field Description

protected String cacheFileName

protected Map<K,V> serializedCache

Constructor Summary

Constructors
Constructor Description

SerializableCache(String cacheFileName)
set cacheFileName to null to disable caching

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cache(K name, V data)`	This will not cache null values.
`void`	`disableCache()`
`void`	`enableCache()`
`void`	`flushCache()`
`V`	`get(K name)`
`boolean`	`isCacheEnabled()`
`Map<K,V>`	`reloadFromFile()`

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

Field Detail

cacheFileName
```
protected String cacheFileName
```

serializedCache
```
protected Map<K,V> serializedCache
```

Constructor Detail
- SerializableCache
```
public SerializableCache(String cacheFileName)
```
  set cacheFileName to null to disable caching
  
  Parameters:
  
  cacheFileName -

Method Detail

isCacheEnabled
```
public boolean isCacheEnabled()
```

cache
```
public void cache(K name,
                  V data)
```
This will not cache null values. Null means not cached yet. If you want to cache "no data exists" use e.g. empty collections to represent this.

Parameters:

name -

data -

get
```
public V get(K name)
```

disableCache
```
public void disableCache()
```

enableCache
```
public void enableCache()
```

reloadFromFile
```
public Map<K,V> reloadFromFile()
```

flushCache
```
public void flushCache()
```