Resource (Apache Sling 8 API)

All Superinterfaces:

Adaptable

All Known Implementing Classes:

AbstractResource, NonExistingResource, ResourceWrapper, SyntheticResource
```
@ProviderType
public interface Resource
extends Adaptable
```
Resources are pieces of content on which Sling acts
The Resource is also an Adaptable to get adapters to other types. A JCR based resource might support adapting to the JCR Node on which the resource is based.
A Resource object is valid for as long as the ResourceResolver that provided this instance is valid. The same applies in general to all objects returned by this instance, especially those returned by a call to Adaptable.adaptTo(Class).
All implementations must support returning a value map from getValueMap(), even if the map is empty.
Implementor's Note: It is recommended to not implement this interface directly. Rather consider either extending from AbstractResource or ResourceWrapper. This will make sure your implementation will not be suffering from missing method problems should the Sling Resource API be extended in the future.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`RESOURCE_TYPE_NON_EXISTING` The special resource type for resource instances representing nonexisting resources (value is "sling:nonexisting").

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Resource`	`getChild(String relPath)` Returns the child at the given relative path of this resource or `null` if no such child exists.
`Iterable<Resource>`	`getChildren()` Returns an iterable of the direct children of this resource.
`String`	`getName()` Returns the name of this resource.
`Resource`	`getParent()` Returns the parent resource or `null` if this resource represents the root of the resource tree.
`String`	`getPath()` Returns the absolute path of this resource in the resource tree.
`ResourceMetadata`	`getResourceMetadata()` Returns the metadata of this resource.
`ResourceResolver`	`getResourceResolver()` Returns the `ResourceResolver` from which this resource has been retrieved.
`String`	`getResourceSuperType()` Returns the super type of the resource if the resource defines its own super type.
`String`	`getResourceType()` The resource type is meant to point to rendering/processing scripts, editing dialogs, etc.
`ValueMap`	`getValueMap()` Returns a value map for this resource.
`boolean`	`hasChildren()` Checks if the resource has any child resources.
`boolean`	`isResourceType(String resourceType)` Returns `true` if the resource type or any of the resource's super type(s) equals the given resource type.
`Iterator<Resource>`	`listChildren()` Returns an iterator of the direct children of this resource.

Methods inherited from interface org.apache.sling.api.adapter.Adaptable
adaptTo

- Field Detail
  - RESOURCE_TYPE_NON_EXISTING
```
static final String RESOURCE_TYPE_NON_EXISTING
```
    The special resource type for resource instances representing nonexisting resources (value is "sling:nonexisting"). This resource type is used by ResourceResolver instances to mark a resource which could not actually be resolved.
    
    See Also:
    
    getResourceType(), ResourceUtil.isNonExistingResource(Resource), ResourceResolver.resolve(javax.servlet.http.HttpServletRequest, String), Constant Field Values
- Method Detail
  - getPath
```
@Nonnull
String getPath()
```
    Returns the absolute path of this resource in the resource tree.
  - getName
```
@Nonnull
String getName()
```
    Returns the name of this resource. The name of a resource is the last segment of the path.
    
    Since:
    
    2.1 (Sling API Bundle 2.2.0)
  - getParent
```
@CheckForNull
Resource getParent()
```
    Returns the parent resource or null if this resource represents the root of the resource tree.
    
    Since:
    
    2.1 (Sling API Bundle 2.1.0)
  - listChildren
```
@Nonnull
Iterator<Resource> listChildren()
```
    Returns an iterator of the direct children of this resource.
    This method is a convenience and returns exactly the same resources as calling getResourceResolver().listChildren(resource).
    
    Since:
    
    2.1 (Sling API Bundle 2.1.0)
    
    See Also:
    
    ResourceResolver.listChildren(Resource)
  - getChildren
```
@Nonnull
Iterable<Resource> getChildren()
```
    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).
    
    Since:
    
    2.2 (Sling API Bundle 2.2.0)
    
    See Also:
    
    ResourceResolver.getChildren(Resource)
  - getChild
```
@CheckForNull
Resource getChild(@Nonnull
                                String relPath)
```
    Returns the child at the given relative path of this resource or null if no such child exists.
    This method is a convenience and returns exactly the same resources as calling getResourceResolver().getResource(resource, relPath).
    
    Since:
    
    2.1 (Sling API Bundle 2.1.0)
    
    See Also:
    
    ResourceResolver.getResource(Resource, String)
  - getResourceType
```
@Nonnull
String getResourceType()
```
    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_TYPE_NON_EXISTING.
  - getResourceSuperType
```
@CheckForNull
String getResourceSuperType()
```
    Returns the super type of the resource if the resource defines its own super type. Otherwise null is returned. A resource might return a resource super type to overwrite the resource type hierarchy. If a client is interested in the effective resource super type of a resource, it should call ResourceResolver.getParentResourceType(Resource).
  - hasChildren
```
boolean hasChildren()
```
    Checks if the resource has any child resources.
    
    Returns:
    
    true if the resource has any child resources
    
    Since:
    
    2.4.4 (Sling API Bundle 2.5.0)
  - isResourceType
```
boolean isResourceType(String resourceType)
```
    Returns true if the resource type or any of the resource's super type(s) equals the given resource type.
    
    Parameters:
    
    resourceType - The resource type to check this resource against.
    
    Returns:
    
    true if the resource type or any of the resource's super type(s) equals the given resource type. false is also returned if resourceType is null.
    
    Since:
    
    2.1.0 (Sling API Bundle 2.1.0)
  - getResourceMetadata
```
@Nonnull
ResourceMetadata getResourceMetadata()
```
    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.
    
    See Also:
    
    ResourceMetadata
  - getResourceResolver
```
@Nonnull
ResourceResolver getResourceResolver()
```
    Returns the ResourceResolver from which this resource has been retrieved.
  - getValueMap
```
@Nonnull
ValueMap getValueMap()
```
    Returns a value map for this resource. The value map allows to read the properties of the resource.
    
    Returns:
    
    A value map
    
    Since:
    
    2.5 (Sling API Bundle 2.7.0)

Interface Resource

Field Summary

Method Summary

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

Field Detail

RESOURCE_TYPE_NON_EXISTING

Method Detail

getPath

getName

getParent

listChildren

getChildren

getChild

getResourceType

getResourceSuperType

hasChildren

isResourceType

getResourceMetadata

getResourceResolver

getValueMap