CacheMarshaller (OpenJPA Parent POM 4.0.0 API)

All Known Implementing Classes:

CacheMarshallerImpl, NoOpCacheMarshaller
```
public interface CacheMarshaller
```
Responsible for marshalling and unmarshalling objects between memory and durable cache.

Since:

1.1.0

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`CacheMarshaller.ValidationPolicy`	Validation policies are responsible for computing whether or not a cached data structure is valid for the current context.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getId()`	The id that this marshaller is responsible for.
`java.lang.Object`	`load()`	Load and return an instance of the type handled by this marshaller.
`void`	`setId(java.lang.String id)`	The id that this marshaller is responsible for.
`void`	`setValidationPolicy(java.lang.String policy)`	The `CacheMarshaller.ValidationPolicy` that this marshaller should use.
`void`	`store(java.lang.Object o)`	Store `o` into the cache.

- Method Detail
  - load
```
java.lang.Object load()
```
    Load and return an instance of the type handled by this marshaller. If the type implements Configurable, then this method will invoke Configurable.setConfiguration(org.apache.openjpa.lib.conf.Configuration), Configurable.startConfiguration(), and Configurable.endConfiguration() on the instance before returning.
  - store
```
void store(java.lang.Object o)
```
    Store o into the cache.
  - setId
```
void setId(java.lang.String id)
```
    The id that this marshaller is responsible for. A value for this parameter is required.
  - getId
```
java.lang.String getId()
```
    The id that this marshaller is responsible for.
  - setValidationPolicy
```
void setValidationPolicy(java.lang.String policy)
                  throws java.lang.InstantiationException,
                         java.lang.IllegalAccessException
```
    The CacheMarshaller.ValidationPolicy that this marshaller should use. A value for this parameter is required. The class will be instantiated via the Configurations mechanism, ensuring that if the class implements Configurable or GenericConfigurable, it will be taken through the appropriate lifecycle.
    
    Throws:
    
    java.lang.InstantiationException
    
    java.lang.IllegalAccessException