org.hippoecm.hst.core.linking

Class DocumentParamsScanner

java.lang.Object

org.hippoecm.hst.core.linking.DocumentParamsScanner

public class DocumentParamsScanner
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentParamsScanner()

Method Summary

Modifier and Type	Method and Description
static List<String>	findDocumentPathsRecursive(HstComponentConfiguration componentConfiguration, ClassLoader classLoader) Returns the document paths for componentConfiguration including its descendant HstComponentConfigurations.
static List<String>	findDocumentPathsRecursive(HstComponentConfiguration componentConfiguration, ClassLoader classLoader, Predicate<HstComponentConfiguration> predicate) Returns the same as findDocumentPathsRecursive(org.hippoecm.hst.configuration.components.HstComponentConfiguration, ClassLoader) only this time during recursive scanning of the componentConfiguration and its descendants, the scanning can be stopped when the Predicate returns false for a HstComponentConfiguration
static Set<String>	getNames(String componentClassName, ClassLoader classLoader)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentParamsScanner

public DocumentParamsScanner()

Method Detail

findDocumentPathsRecursive

public static List<String> findDocumentPathsRecursive(HstComponentConfiguration componentConfiguration,
                                                      ClassLoader classLoader)

Returns the document paths for componentConfiguration including its descendant HstComponentConfigurations. A document path is an method from the ParametersInfo that is either annotated with JcrPath or DocumentLink. The componentConfiguration java class will be loaded by the provided classLoader

Parameters:

componentConfiguration - the root HstComponentConfiguration for which all document paths will be returned. All as in that also all descendant HstComponentConfigurations are scanned.

Returns:

List of document paths parameters for the componentConfiguration including all its descendant HstComponentConfigurations.

findDocumentPathsRecursive

public static List<String> findDocumentPathsRecursive(HstComponentConfiguration componentConfiguration,
                                                      ClassLoader classLoader,
                                                      Predicate<HstComponentConfiguration> predicate)

Returns the same as findDocumentPathsRecursive(org.hippoecm.hst.configuration.components.HstComponentConfiguration, ClassLoader) only this time during recursive scanning of the componentConfiguration and its descendants, the scanning can be stopped when the Predicate returns false for a HstComponentConfiguration

See Also:

findDocumentPathsRecursive(org.hippoecm.hst.configuration.components.HstComponentConfiguration, ClassLoader)

getNames

public static Set<String> getNames(String componentClassName,
                                   ClassLoader classLoader)

Parameters:

componentClassName - the class name for which the ParametersInfo is scanned

Returns:

Set of parameter names that have either JcrPath or DocumentLink annotation present. Returns empty set if and exception occurs (for example componentClassName cannot be instantiated) or no ParametersInfo is present on componentClassName