com.adobe.cq.social.scf.utilities.internal

Interface InternalSCFUtilities

public interface InternalSCFUtilities

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_AVATAR

Method Summary

Modifier and Type	Method and Description
Page	getPage(java.lang.String path, ResourceResolver resolver)
java.lang.String	getPagePath(Resource resource) Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.
java.lang.String	getPagePath(java.lang.String path) Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.
java.lang.String	getResourceTypeForIncludedResource(Resource component, java.lang.String defaultResourceType, java.lang.String designPropertyName) Returns the resource type of a Component when it is included dynamically via cq:include.
java.lang.String	getResourceTypeFromDesign(Resource resource, java.lang.String styleProperty, java.lang.String defaultValue) Returns the resource type from the design applied to the resource.

Field Detail

DEFAULT_AVATAR

static final java.lang.String DEFAULT_AVATAR

See Also:

Constant Field Values

Method Detail

getPagePath

@CheckForNull
java.lang.String getPagePath(@Nullable
                                           Resource resource)

Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.

Parameters:

resource - The resource to check.

Returns:

A String representing the page path.

getPagePath

@CheckForNull
java.lang.String getPagePath(@Nullable
                                           java.lang.String path)

Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.

Parameters:

path - The path to check.

Returns:

A String representing the page path.

getPage

@CheckForNull
Page getPage(java.lang.String path,
                           ResourceResolver resolver)

Parameters:

path - path to the page

resolver - resolver to us

Returns:

the Page object for the given path if a page exists, null otherwise.

getResourceTypeFromDesign

@CheckForNull
java.lang.String getResourceTypeFromDesign(Resource resource,
                                                         java.lang.String styleProperty,
                                                         java.lang.String defaultValue)

Returns the resource type from the design applied to the resource.

Parameters:

resource - the resource to check the design property for

styleProperty - the name of the design property to check

defaultValue - a default string value

Returns:

the resource

getResourceTypeForIncludedResource

@CheckForNull
java.lang.String getResourceTypeForIncludedResource(Resource component,
                                                                  java.lang.String defaultResourceType,
                                                                  java.lang.String designPropertyName)

Returns the resource type of a Component when it is included dynamically via cq:include. This will check the component node, then the design to determine if one is available, if it cannot retrieve another resource type it will return the defaultResourceType.

Parameters:

component - the component to determine the type for

defaultResourceType - the fall back if no suitable matchers are found

designPropertyName - the name of the design property to try and use

Returns:

a valid resource type to use when dealing with dynamically included components