org.alfresco.service.cmr.repository

Interface SerializedTransformationOptionsAccessor

All Known Implementing Classes:

AbstractRenderingEngine.RenderingContext

@AlfrescoPublicApi
public interface SerializedTransformationOptionsAccessor

Defines methods for retrieving parameter values for use in building transformation options.

Author:

Ray Gauss II

Method Summary

Modifier and Type	Method and Description
<T> T	getCheckedParam(String paramName, Class<T> clazz) Gets the value for the named parameter.
int	getIntegerParam(String key, int defaultValue) Gets the int value for the named parameter.
<T> T	getParamWithDefault(String paramName, T defaultValue) Gets the value for the named parameter.

Method Detail

getCheckedParam

<T> T getCheckedParam(String paramName,
                      Class<T> clazz)

Gets the value for the named parameter. Checks the type of the parameter is correct and throws and Exception if it isn't. Returns null if the parameter value is null

Parameters:

paramName - the name of the parameter being checked.

clazz - the expected Class of the parameter value.

Returns:

the parameter value or null.

getParamWithDefault

<T> T getParamWithDefault(String paramName,
                          T defaultValue)

Gets the value for the named parameter. Checks the type of the parameter is the same as the type of defaultValue and throws a RenditionServiceException if it isn't. Returns defaultValue if the parameter value is null

Parameters:

paramName - String

getIntegerParam

int getIntegerParam(String key,
                    int defaultValue)

Gets the int value for the named parameter. Returns defaultValue if the parameter value is null.

Parameters:

key - String

defaultValue - int

Returns:

int