org.hippoecm.hst.core.component

Interface HstParameterInfoProxyFactory

All Known Implementing Classes:

HstParameterInfoProxyFactoryImpl

public interface HstParameterInfoProxyFactory

HstParameterInfoProxyFactory is a factory interface for creating a proxy for an interface that is referred to by a ParametersInfo annotation. The ParametersInfo annotation is used to annotate HstComponent classes. The interface referred to by the ParametersInfo annotation is returned as proxy by the createParameterInfoProxy(ParametersInfo, ComponentConfiguration, HstRequest, HstParameterValueConverter) method. The getters in the interface that are annotated with the Parameter annotation are delegated through the proxy to the backing ComponentConfiguration

Method Summary

Modifier and Type	Method and Description
<T> T	createParameterInfoProxy(ParametersInfo parametersInfo, ComponentConfiguration componentConfig, HstRequest request, HstParameterValueConverter converter) Returns a proxy instance of the interface T.

Method Detail

createParameterInfoProxy

<T> T createParameterInfoProxy(ParametersInfo parametersInfo,
                               ComponentConfiguration componentConfig,
                               HstRequest request,
                               HstParameterValueConverter converter)

Returns a proxy instance of the interface T. The proxy delegates the Parameter annotated getters in the interface T to the backing ComponentConfiguration parameters, thus to ComponentConfiguration.getParameter(String, org.hippoecm.hst.core.request.ResolvedSiteMapItem)

Type Parameters:

T - proxy instance of the interface T

Parameters:

parametersInfo - the ParametersInfo annotation of the HstComponent

componentConfig - the backing ComponentConfiguration of the HstComponent

request - the HstRequest

converter - the HstParameterValueConverter that does the actual conversion

Returns:

proxy instance of the interface T

Throws:

IllegalArgumentException - if ParametersInfo.type() does not return an interface or when parameterValueConverter is null