CacheHints (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.cache.volatiles.CacheHints

```
public class CacheHints
extends Object
```
Hints to a cache on how to handle data requests. Consists of the LoadingStrategy for entries, the priority with which to enqueue entries to the BlockingFetchQueues (if they are enqueued) and whether they should be enqueued to the front (most recent requests are handled first) or back (requests are handled in order) of the respective priority level.
The number of priority levels n is fixed when the cache is constructed. Priorities are consecutive integers 0 ... n-1, where 0 is the highest priority.
In BigDataViewer, priorities usually correspond to resolution levels in some way. For example this can be used to load low-resolution data first.

Author:

Tobias Pietzsch

Constructor Summary

Constructors
Constructor and Description

CacheHints(LoadingStrategy loadingStrategy, int queuePriority, boolean enqueuToFront)

Constructors
Constructor and Description
`CacheHints(LoadingStrategy loadingStrategy, int queuePriority, boolean enqueuToFront)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`LoadingStrategy`	`getLoadingStrategy()` Get the `LoadingStrategy` to use when accessing data that is not in the cache yet.
`int`	`getQueuePriority()` Get the priority with which entry requests are enqueued (if they are enqueued).
`int`	`hashCode()`
`boolean`	`isEnqueuToFront()` Return true if cell requests should be enqueued to the front (most recent requests are handled first) of the respective `priority level`.
`String`	`toString()`

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

- Constructor Detail
  - CacheHints
```
public CacheHints(LoadingStrategy loadingStrategy,
                  int queuePriority,
                  boolean enqueuToFront)
```
    Parameters:
    
    loadingStrategy -
    
    queuePriority -
    
    enqueuToFront -
- Method Detail
  - getLoadingStrategy
```
public LoadingStrategy getLoadingStrategy()
```
    Get the LoadingStrategy to use when accessing data that is not in the cache yet.
    
    Returns:
    
    LoadingStrategy to use when accessing data that is not in the cache yet.
  - getQueuePriority
```
public int getQueuePriority()
```
    Get the priority with which entry requests are enqueued (if they are enqueued).
    
    Returns:
    
    the priority with which requests are enqueued. lower values mean higher priority.
  - isEnqueuToFront
```
public boolean isEnqueuToFront()
```
    Return true if cell requests should be enqueued to the front (most recent requests are handled first) of the respective priority level. Return false, if cell requests should be enqueued to the back (requests are handled in order).
    
    Returns:
    
    true if request should be added to the front of the queue, false if they should be added to the back
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheHints

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheHints

Method Detail

getLoadingStrategy

getQueuePriority

isEnqueuToFront

equals

hashCode

toString