org.apache.sling.bundleresource.impl
Class BundleResource

java.lang.Object
  extended by org.apache.sling.api.adapter.SlingAdaptable
      extended by org.apache.sling.api.resource.AbstractResource
          extended by org.apache.sling.bundleresource.impl.BundleResource
All Implemented Interfaces:
Adaptable, Resource

public class BundleResource
extends AbstractResource
implements Resource

A Resource that wraps a Bundle entry


Field Summary
 
Fields inherited from interface org.apache.sling.api.resource.Resource
RESOURCE_TYPE_NON_EXISTING
 
Constructor Summary
BundleResource(ResourceResolver resourceResolver, org.apache.sling.bundleresource.impl.BundleResourceCache bundle, org.apache.sling.bundleresource.impl.MappedPath mappedPath, String resourcePath)
           
 
Method Summary
<Type> Type
adaptTo(Class<Type> type)
          Adapts the adaptable to another type.
 String getPath()
          Returns the absolute path of this resource in the resource tree.
static BundleResource getResource(ResourceResolver resourceResolver, org.apache.sling.bundleresource.impl.BundleResourceCache bundle, org.apache.sling.bundleresource.impl.MappedPath mappedPath, String resourcePath)
           
 ResourceMetadata getResourceMetadata()
          Returns the metadata of this resource.
 ResourceResolver getResourceResolver()
          Returns the ResourceResolver from which this resource has been retrieved.
 String getResourceSuperType()
          Returns null, bundle resources have no super type
 String getResourceType()
          The resource type is meant to point to rendering/processing scripts, editing dialogs, etc.
 Iterator<Resource> listChildren()
          Returns an iterator on the direct child resources.
 String toString()
           
 
Methods inherited from class org.apache.sling.api.resource.AbstractResource
getChild, getName, getParent, isResourceType
 
Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable
setAdapterManager, unsetAdapterManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.sling.api.resource.Resource
getChild, getName, getParent, isResourceType
 

Constructor Detail

BundleResource

public BundleResource(ResourceResolver resourceResolver,
                      org.apache.sling.bundleresource.impl.BundleResourceCache bundle,
                      org.apache.sling.bundleresource.impl.MappedPath mappedPath,
                      String resourcePath)
Method Detail

getResource

public static BundleResource getResource(ResourceResolver resourceResolver,
                                         org.apache.sling.bundleresource.impl.BundleResourceCache bundle,
                                         org.apache.sling.bundleresource.impl.MappedPath mappedPath,
                                         String resourcePath)

getPath

public String getPath()
Description copied from interface: Resource
Returns the absolute path of this resource in the resource tree.

Specified by:
getPath in interface Resource

getResourceType

public String getResourceType()
Description copied from interface: Resource
The resource type is meant to point to rendering/processing scripts, editing dialogs, etc. It is usually a path in the repository, where scripts and other tools definitions are found, but the ResourceResolver is free to set this to any suitable value such as the primary node type of the JCR node from which the resource is created.

If the resource instance represents a resource which is not actually existing, this method returns Resource.RESOURCE_TYPE_NON_EXISTING.

Specified by:
getResourceType in interface Resource

getResourceSuperType

public String getResourceSuperType()
Returns null, bundle resources have no super type

Specified by:
getResourceSuperType in interface Resource

getResourceMetadata

public ResourceMetadata getResourceMetadata()
Description copied from interface: Resource
Returns the metadata of this resource. The concrete data contained in the ResourceMetadata object returned is implementation specific except for the ResourceMetadata.RESOLUTION_PATH property which is required to be set to the part of the request URI used to resolve the resource.

Specified by:
getResourceMetadata in interface Resource
See Also:
ResourceMetadata

getResourceResolver

public ResourceResolver getResourceResolver()
Description copied from interface: Resource
Returns the ResourceResolver from which this resource has been retrieved.

Specified by:
getResourceResolver in interface Resource

adaptTo

public <Type> Type adaptTo(Class<Type> type)
Description copied from interface: Adaptable
Adapts the adaptable to another type.

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 Node.class
Returns:
The adapter target or null if the resource cannot adapt to the requested type
See Also:
Adaptable.adaptTo(java.lang.Class)

toString

public String toString()
Overrides:
toString in class Object

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
See Also:
ResourceResolver.listChildren(Resource)


Copyright © 2007-2013 The Apache Software Foundation. All Rights Reserved.