org.apache.sling.api.adapter

Interface Adaptable

All Known Subinterfaces:

Asset, Asset, AssetVersion, Authorizable, BinaryRendition, Blueprint, Blueprint, CarouselSet, ChannelConfig, Component, ConnectorResource, ContentElement, ContentFragment, ContentPolicy, ConverterContext, Device, DeviceConfig, ElementTemplate, ExperienceFragment, ExperienceFragmentSocialVariation, ExperienceFragmentVariation, FragmentTemplate, Group, ImageSet, MapResource, MediaSet, Page, Product, Project, ProjectLink, Promotion, Rendition, Rendition, Resource, ResourceResolver, SlingHttpServletRequest, SlingHttpServletResponse, SocialResource, SpinSet, SwatchSet, Tag, Template, TemplatedResource, User, VirtualComponent, WorkflowSession

All Known Implementing Classes:

AbstractJcrProduct, AbstractJcrVoucher, AbstractResource, Address, AuthorizableResource, CustomParameterRequest, CustomResponse, Download, DownloadResource, FDMRendition, FilteringResourceWrapper, FormsHandlingRequest, FormsHandlingResponse, GroupResource, GuideValueMapResource, Image, ImageResource, JspSlingHttpServletResponseWrapper, Location, MapResourceImpl, MergedMultiResource, NonExistingResource, Paragraph, RedirectRequest, ResourceResolverWrapper, ResourceWrapper, ResponsiveColumn, ResponsiveGrid, SlingAdaptable, SlingAdaptable, SlingHttpServletRequestWrapper, SlingHttpServletResponseWrapper, SocialPropertyResourceImpl, StringResponseWrapper, SyntheticResource, ThemeRendition, UserResource, ValueMapResource, ValueMapResourceWrapper, WCMFilteringResourceWrapper

@ConsumerType
public interface Adaptable

The Adaptable interface identifies objects which can be adapted to other types or representations of the same object. For example a JCR Node based Resource can adapt to the underlying JCR Node or a file based resource could adapt to the underlying java.io.File.

Method Summary

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(@NotNull java.lang.Class<AdapterType> type) Adapts the adaptable to another type.

Method Detail

adaptTo

@Nullable
<AdapterType> AdapterType adaptTo(@NotNull
                                            @NotNull java.lang.Class<AdapterType> type)

Adapts the adaptable to another type.

Please note that it is explicitly left as an implementation detail whether each call to this method with the same type yields the same object or a new object on each call.

Implementations of this method should document their adapted types as well as their behaviour with respect to returning newly created or same instances on each call.

Type Parameters:

AdapterType - The generic type to which this object 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 object cannot adapt to the requested type