com.adobe.cq.wcm.core.components.models

Interface ComponentFiles

@ConsumerType
public interface ComponentFiles

This utility model allows looking up the paths of specific files from a collection of components, specified as Sling resource types.

Since:

com.adobe.cq.wcm.core.components.models 12.14.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTION_FILTER_REGEX Name of the option used to specify the regular expression that needs to be matched by files to be collected.
static String	OPTION_INHERITED Name of the option used to specify if files should be searched up the inheritance chain (using Sling resource supertype).
static boolean	OPTION_INHERITED_DEFAULT Default value for OPTION_INHERITED.
static String	OPTION_RESOURCE_TYPES Name of the option used to specify the Collection of resource types.

Method Summary

Modifier and Type	Method and Description
default List<String>	getPaths() Returns a list of paths for files inside the components (specified by the resource types) that match the given filter regex.

Field Detail

OPTION_RESOURCE_TYPES

static final String OPTION_RESOURCE_TYPES

Name of the option used to specify the Collection of resource types.

Since:

com.adobe.cq.wcm.core.components.models 12.14.0

See Also:

Constant Field Values

OPTION_FILTER_REGEX

static final String OPTION_FILTER_REGEX

Name of the option used to specify the regular expression that needs to be matched by files to be collected.

Since:

com.adobe.cq.wcm.core.components.models 12.14.0

See Also:

Constant Field Values

OPTION_INHERITED

static final String OPTION_INHERITED

Name of the option used to specify if files should be searched up the inheritance chain (using Sling resource supertype).

Since:

com.adobe.cq.wcm.core.components.models 12.14.0

See Also:

Constant Field Values

OPTION_INHERITED_DEFAULT

static final boolean OPTION_INHERITED_DEFAULT

Default value for OPTION_INHERITED.

Since:

com.adobe.cq.wcm.core.components.models 12.14.0

See Also:

Constant Field Values

Method Detail

getPaths

default List<String> getPaths()

Returns a list of paths for files inside the components (specified by the resource types) that match the given filter regex.

Returns:

List of file paths

Since:

com.adobe.cq.wcm.core.components.models 12.14.0