PdfConfigurationProcessor.Update (Mapfish Print Core Module 0.20240425.105312.SNAPSHOT)

java.lang.Object
- org.mapfish.print.processor.PdfConfigurationProcessor.Update

All Implemented Interfaces:

ConfigurationObject

Enclosing class:

PdfConfigurationProcessor
```
public static final class PdfConfigurationProcessor.Update
extends java.lang.Object
implements ConfigurationObject
```
The object that defines how to update the PDFConfig (see !updatePdfConfig processor). [[examples=updatePdfMetadata]]

Constructor Summary

Constructors
Constructor Description

Update()
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`setFormat(java.lang.String format)`	The replacement format.
`void`	`setValueKey(java.lang.String valueKey)`	The key to use to look up the value in the values object.
`void`	`validate(java.util.List<java.lang.Throwable> validationErrors, Configuration configuration)`	validate that the configuration was correct.

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

- Constructor Detail
  - Update
```
public Update()
```
    Default constructor.
- Method Detail
  - validate
```
public void validate(java.util.List<java.lang.Throwable> validationErrors,
                     Configuration configuration)
```
    Description copied from interface: ConfigurationObject
    
    validate that the configuration was correct.
    
    Specified by:
    
    validate in interface ConfigurationObject
    
    Parameters:
    
    validationErrors - a list to add any detected errors to.
    
    configuration - the containing configuration
  - setValueKey
```
public void setValueKey(java.lang.String valueKey)
```
    The key to use to look up the value in the values object. It can be a path that can reach into nested objects.
    Examples 1 a simple lookup key: "key" Example 2 a path. First part (before .) is the lookup key, the second part is the field name to load: "key.fieldName"
    
    Parameters:
    
    valueKey - the path or key for retrieving the value
  - setFormat
```
public void setFormat(java.lang.String format)
```
    The replacement format. It is a printf style format. The documentation is in the Formatter class (just google/bing java.util.Formatter).
    Example: "Report for %s"
    
    Parameters:
    
    format - the update format. There can only be a single value.