CacheOptions.CacheType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<CacheOptions.CacheType>
- - net.imglib2.cache.img.optional.CacheOptions.CacheType

All Implemented Interfaces:

Serializable, Comparable<CacheOptions.CacheType>

Enclosing interface:

CacheOptions<T>
```
public static enum CacheOptions.CacheType
extends Enum<CacheOptions.CacheType>
```
Rough in-memory cache types.

Author:

Tobias Pietzsch

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BOUNDED` The cache keeps strong references to a limited number of values (cells).
`SOFTREF` The cache keeps SoftReferences to values (cells), basically relying on GC for removal.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CacheOptions.CacheType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CacheOptions.CacheType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SOFTREF
```
public static final CacheOptions.CacheType SOFTREF
```
    The cache keeps SoftReferences to values (cells), basically relying on GC for removal. The advantage of this is that many caches can be created without needing to put a limit on the size of any of them. GC will take care of balancing that. The downside is that OutOfMemoryError may occur because SoftReferences are cleared too slow. SoftReferences are not collected for a certain time after they have been used. If there is heavy thrashing with cells being constantly swapped in and out from disk then OutOfMemory may happen because of this. This sounds worse than it is in practice and should only happen in pathological situations. Tuning the -XX:SoftRefLRUPolicyMSPerMB JVM flag does often help.
  - BOUNDED
```
public static final CacheOptions.CacheType BOUNDED
```
    The cache keeps strong references to a limited number of values (cells). The advantage is that there is never OutOfMemory because of the issues described above (fingers crossed). The downside is that the number of cells that should be cached needs to be specified beforehand. So OutOfMemoryError may occur if many caches are opened and consume too much memory in total.
- Method Detail
  - values
```
public static CacheOptions.CacheType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (CacheOptions.CacheType c : CacheOptions.CacheType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CacheOptions.CacheType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum CacheOptions.CacheType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SOFTREF

BOUNDED

Method Detail

values

valueOf