com.adobe.granite.ui.components.rendercondition

Class RenderConditionHelper

java.lang.Object

com.adobe.granite.ui.components.rendercondition.RenderConditionHelper

public class RenderConditionHelper
extends Object

A helper to get RenderCondition of a resource.

Constructor Summary

Constructors

Constructor and Description
RenderConditionHelper(SlingHttpServletRequest request, SlingHttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
RenderCondition	getRenderCondition(Resource resource) Returns the render condition of the given resource.
RenderCondition	getRenderCondition(Resource resource, boolean cache) Returns the render condition of the given resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderConditionHelper

public RenderConditionHelper(@Nonnull
                             SlingHttpServletRequest request,
                             @Nonnull
                             SlingHttpServletResponse response)

Method Detail

getRenderCondition

@Nonnull
public RenderCondition getRenderCondition(@Nonnull
                                                   Resource resource)
                                            throws ServletException,
                                                   IOException

Returns the render condition of the given resource. This method is an overload of getRenderCondition(Resource, boolean) with cache = false.

Parameters:

resource - The resource whose render condition needs to be fetched

Returns:

The render condition

Throws:

ServletException - When there's a servlet error during include

IOException - When there's an I/O error during include

getRenderCondition

@Nonnull
public RenderCondition getRenderCondition(@Nonnull
                                                   Resource resource,
                                                   boolean cache)
                                            throws ServletException,
                                                   IOException

Returns the render condition of the given resource. The render condition is specified by granite:rendercondition subresource. If there is no such subresource, SimpleRenderCondition.TRUE is returned.

Parameters:

resource - The resource whose render condition needs to be fetched

cache - true to cache the result; Use it when checking render condition of other resource (typically the item resource) so that the render condition is only resolved once.

Returns:

The render condition

Throws:

ServletException - When there's a servlet error during include

IOException - When there's an I/O error during include