Package com.adobe.granite.ui.components.ds

Class ValueMapResource

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.api.resource.AbstractResource

org.apache.sling.api.resource.SyntheticResource

com.adobe.granite.ui.components.ds.ValueMapResource

All Implemented Interfaces:

Adaptable, Resource

public class ValueMapResource
extends SyntheticResource

A SyntheticResource that will return the passed ValueMap when this resource is adapted to ValueMap.

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor	Description
ValueMapResource(ResourceResolver resourceResolver, String path, String resourceType)	Instantiates with an empty ValueMap initially.
ValueMapResource(ResourceResolver resourceResolver, String path, String resourceType, ValueMap vm)	Instantiates with the given ValueMap.
ValueMapResource(ResourceResolver resourceResolver, String path, String resourceType, ValueMap vm, Collection<Resource> children)	Instantiates with the given child resources.
ValueMapResource(ResourceResolver resourceResolver, ResourceMetadata rm, String resourceType)	Instantiates with an empty ValueMap initially.
ValueMapResource(ResourceResolver resourceResolver, ResourceMetadata rm, String resourceType, ValueMap vm)	Instantiates with the given ValueMap.
ValueMapResource(ResourceResolver resourceResolver, ResourceMetadata rm, String resourceType, ValueMap vm, Collection<Resource> children)	Instantiates with the given child resources.

Method Summary

Modifier and Type	Method	Description
<Type> Type	adaptTo(Class<Type> type)	Calls into the registered AdapterManager to adapt this object to the desired type.
Resource	getChild(String relPath)	Returns the indicated child of this resource.
Iterable<Resource>	getChildren()	Returns an iterable of the direct children of this resource.
boolean	hasChildren()	Checks to see if there are direct children of this resource by invoking ResourceResolver.hasChildren(Resource).
Iterator<Resource>	listChildren()	Returns an iterator on the direct child resources.

Methods inherited from class org.apache.sling.api.resource.SyntheticResource

getPath, getResourceMetadata, getResourceResolver, getResourceSuperType, getResourceType, toString

Methods inherited from class org.apache.sling.api.resource.AbstractResource

getName, getParent, getValueMap, isResourceType

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

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

Constructor Details

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 String path,
 String resourceType)

Instantiates with an empty ValueMap initially.

Parameters:

resourceResolver - The resource resolver

path - The resource path

resourceType - The resource type

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 String path,
 String resourceType,
 @Nonnull
 ValueMap vm)

Instantiates with the given ValueMap.

Parameters:

resourceResolver - The resource resolver

path - The resource path

resourceType - The resource type

vm - The ValueMap of the resource

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 String path,
 String resourceType,
 @Nonnull
 ValueMap vm,
 @CheckForNull
 Collection<Resource> children)

Instantiates with the given child resources.

Parameters:

resourceResolver - The resource resolver

path - The resource path

resourceType - The resource type

vm - The ValueMap of the resource

children - The children of the resource

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 ResourceMetadata rm,
 String resourceType)

Instantiates with an empty ValueMap initially.

Parameters:

resourceResolver - The resource resolver

rm - The resource meta data

resourceType - The resource type

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 ResourceMetadata rm,
 String resourceType,
 @Nonnull
 ValueMap vm)

Instantiates with the given ValueMap.

Parameters:

resourceResolver - The resource resolver

rm - The resource meta data

resourceType - The resource type

vm - The ValueMap of the resource

ValueMapResource

public ValueMapResource(ResourceResolver resourceResolver,
 ResourceMetadata rm,
 String resourceType,
 @Nonnull
 ValueMap vm,
 @CheckForNull
 Collection<Resource> children)

Instantiates with the given child resources.

Parameters:

resourceResolver - The resource resolver

rm - The resource meta data

resourceType - The resource type

vm - The ValueMap of the resource

children - The children of the resource

Method Details

adaptTo

public <Type> Type adaptTo(Class<Type> type)

Description copied from class: SlingAdaptable

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

Type - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type

getChild

public Resource getChild(String relPath)

Description copied from class: AbstractResource

Returns the indicated child of this resource.

This method is implemented calling the ResourceResolver.getResource(Resource, String) method. As such the relPath argument may even be an absolute path or a path containing relative path segments . (current resource) and .. (parent resource).

Implementations should not generally overwrite this method without calling this base class implementation.

Specified by:

getChild in interface Resource

Overrides:

getChild in class AbstractResource

Parameters:

relPath - relative path to the child resource

Returns:

The child resource or null

See Also:

• ResourceResolver.getResource(Resource, String)

listChildren

public Iterator<Resource> listChildren()

Description copied from class: AbstractResource

Returns an iterator on the direct child resources.

This method is implemented calling the ResourceResolver.listChildren(Resource) method.

Implementations should not generally overwrite this method without calling this base class implementation.

Specified by:

listChildren in interface Resource

Overrides:

listChildren in class AbstractResource

Returns:

An iterator for child resources.

See Also:

• ResourceResolver.listChildren(Resource)

getChildren

public Iterable<Resource> getChildren()

Description copied from interface: Resource

Returns an iterable of the direct children of this resource.

This method is a convenience and returns exactly the same resources as calling getResourceResolver().getChildren(resource).

Specified by:

getChildren in interface Resource

Overrides:

getChildren in class AbstractResource

Returns:

An iterable for child resources

See Also:

• Resource.getChildren()

hasChildren

public boolean hasChildren()

Description copied from class: AbstractResource

Checks to see if there are direct children of this resource by invoking ResourceResolver.hasChildren(Resource).

Specified by:

hasChildren in interface Resource

Overrides:

hasChildren in class AbstractResource

Returns:

true if the resource has any child resources