MEMORY_POLICY (pepper-framework 3.6.1 API)

java.lang.Object
- java.lang.Enum<MEMORY_POLICY>
- - org.corpus_tools.pepper.common.MEMORY_POLICY

All Implemented Interfaces:

Serializable, Comparable<MEMORY_POLICY>
```
public enum MEMORY_POLICY
extends Enum<MEMORY_POLICY>
```
Describes the main memory policy of PepperJobs. More specific, it determines the way of loading and storing SDocumentGraph objects during the processing. The behavior of the DocumentBus is described as follows:
- THRIFTY - each time, a PepperModule is setting a SDocument to DOCUMENT_STATUS.COMPLETED and no other PepperModule is currently working on it, it will be send to sleep.
- MODERATE - each time, a PepperModule is setting a SDocument to DOCUMENT_STATUS.COMPLETED, no other PepperModule is currently working on it and no other PepperModule is waiting on it, it will be send to sleep.
- GREEDY - A SDocumentGraph will never be send to sleep. In case of the number of maximal processed documents is limited, and was reached, no further SDocumentGraphs will be imported until one was finished somehow.
Author:

Florian Zipser

Enum Constant Summary

Enum Constants
Enum Constant Description

GREEDY

MODERATE

THRIFTY

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static MEMORY_POLICY`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static MEMORY_POLICY[]`	`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
  - THRIFTY
```
public static final MEMORY_POLICY THRIFTY
```
  - MODERATE
```
public static final MEMORY_POLICY MODERATE
```
  - GREEDY
```
public static final MEMORY_POLICY GREEDY
```
- Method Detail
  - values
```
public static MEMORY_POLICY[] 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 (MEMORY_POLICY c : MEMORY_POLICY.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MEMORY_POLICY 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