Package org.hippoecm.hst.core.parameters
Annotation Type ParametersInfo
-
@Retention(RUNTIME) @Target(TYPE) public @interface ParametersInfo
This is an annotation to be used for org.hippoecm.hst.core.component.HstComponent's. This way, an org.hippoecm.hst.core.component.HstComponent's parameters can be bridged to the actual parameters to be expected in the org.hippoecm.hst.configuration.components.HstComponentConfiguration. Also, this annotation can be used to inform YUI tools about which parameters can be configured for the org.hippoecm.hst.core.component.HstComponent that has this annotation.
For example you can write your org.hippoecm.hst.core.component.HstComponent for a search as follows:
@ParametersInfo(type = SearchInfo.class) public class Search extends BaseHstComponent { public static final Logger log = LoggerFactory.getLogger(SearchNoParameterInfo.class); @Override public void doBeforeRender(HstRequest request, HstResponse response) throws HstComponentException { SearchInfo info = getParametersInfo(request); } }
-
-
Element Detail
-
type
Class<?> type
-
-