com.adobe.cq.mobile.platform

Interface MobileResourceLocator

public interface MobileResourceLocator

The MobileResourceLocator provides methods to assist with finding mobile applications.

Method Summary

Modifier and Type	Method and Description
MobileResource	findAncestorResourceByType(Resource resource, java.lang.String type, java.lang.String... stopTypes) Traverse through parent resources to locate a type matching the type parameter.
MobileResource	findClosestResourceByType(Resource resource, java.lang.String type, java.lang.String... stopTypes) Locate the closest mobile resource matching to specified type.
java.lang.Iterable<MobileResource>	findResourcesByType(Resource resource, java.lang.String type) Find all child resources matching the requested app type.
MobileResource	getResourceByType(Resource resource, java.lang.String type, boolean deep) Traverse over child resources to locate a resource matching the requested app type.

Method Detail

findResourcesByType

java.lang.Iterable<MobileResource> findResourcesByType(Resource resource,
                                                       java.lang.String type)

Find all child resources matching the requested app type.

Parameters:

resource - Resource The resource to start searching from.

type - Mobile resource type id. Use MobileResourceType for common app types.

Returns:

A list of all child resources matching the requested type.

getResourceByType

MobileResource getResourceByType(Resource resource,
                                 java.lang.String type,
                                 boolean deep)

Traverse over child resources to locate a resource matching the requested app type.

Parameters:

resource - Resource The resource to start iterating from

type - Mobile resource type id. Use MobileResourceType for common app types.

deep - If true the child resources will be also analyzed

Returns:

The first resource found matching the requested type.

findAncestorResourceByType

MobileResource findAncestorResourceByType(Resource resource,
                                          java.lang.String type,
                                          java.lang.String... stopTypes)

Traverse through parent resources to locate a type matching the type parameter. If found, its resource will be returned, otherwise null will be returned. Processing will also stop if any types specified in the stopTypes array are found first.

Parameters:

resource - The resource to start searching from.

type - The mobile resource type id. Use MobileResourceType for common app types.

stopTypes - An array of types that will stop processing.

Returns:

A MobileResource matching the found type.

findClosestResourceByType

MobileResource findClosestResourceByType(Resource resource,
                                         java.lang.String type,
                                         java.lang.String... stopTypes)

Locate the closest mobile resource matching to specified type. This mobile resource will be compared first before its ancestors are. A value of null will be returned if no match is found.

Parameters:

resource - The resource to start searching from.

type - The mobile resource type id. Use MobileResourceType for common app types.

stopTypes - An array of types that will stop processing.

Returns:

A MobileResource of the closest matching type, if any exist.