Class PdfConversionParams

java.lang.Object

de.xima.fc.transform.pdf.convert.PdfConversionParams

public class PdfConversionParams
extends Object

Optional conversion parameters, see the particular converter implementations for supported values.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PdfConversionParams.ParamNames	Some parameter names.

Field Summary

Fields

Modifier and Type	Field	Description
static final PdfConversionParams	EMPTY	Empty parameter set, may be used to let the converter apply its defaults.

Constructor Summary

Constructors

Constructor	Description
PdfConversionParams()

Method Summary

Modifier and Type	Method	Description
<T> T	get(String paramName)
<T> T	get(String paramName, T fallbackValue)
<T> PdfConversionParams	set(String paramName, T paramValue)	Fluent parameter setter.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY

public static final PdfConversionParams EMPTY

Empty parameter set, may be used to let the converter apply its defaults.

Constructor Details

PdfConversionParams

public PdfConversionParams()

Method Details

set

public <T> PdfConversionParams set(String paramName,
 T paramValue)

Fluent parameter setter.

Type Parameters:

T - the type of the parameter value

Parameters:

paramName - name of the parameter, known parameter names can be found under PdfConversionParams.ParamNames

paramValue - the parameter value

Returns:

this

get

public <T> T get(String paramName)

Type Parameters:

T - the type of the parameter value

Parameters:

paramName - name of the parameter, known parameter names can be found under PdfConversionParams.ParamNames

Returns:

the parameter value or null, if there's no such parameter

get

public <T> T get(String paramName,
 T fallbackValue)

Type Parameters:

T - the type of the parameter value

Parameters:

paramName - name of the parameter, known parameter names can be found under PdfConversionParams.ParamNames

fallbackValue - value to be used, if there's no parameter with the provided name

Returns:

the parameter value or the passed fallback value, if there's no such parameter