Package io.wcm.handler.media

Class MediaComponentPropertyResolver

java.lang.Object

io.wcm.handler.media.MediaComponentPropertyResolver

All Implemented Interfaces:

AutoCloseable

@ProviderType
public final class MediaComponentPropertyResolver
extends Object
implements AutoCloseable

Resolves Media Handler component properties for the component associated with the given resource from content policies and properties defined in the component resource. Please make sure to close() instances of this class after usage.

Constructor Summary

Constructors

Constructor	Description
MediaComponentPropertyResolver(@NotNull org.apache.sling.api.resource.Resource resource)	Deprecated. Please use MediaComponentPropertyResolver(Resource, ComponentPropertyResolverFactory)
MediaComponentPropertyResolver(@NotNull org.apache.sling.api.resource.Resource resource, @NotNull io.wcm.wcm.commons.component.ComponentPropertyResolverFactory componentPropertyResolverFactory)

Method Summary

Modifier and Type	Method	Description
void	close()
@Nullable MediaArgs.ImageSizes	getImageSizes()
@NotNull String @Nullable []	getMandatoryMediaFormatNames()
@NotNull String @Nullable []	getMediaFormatNames()
@NotNull MediaArgs.MediaFormatOption @Nullable []	getMediaFormatOptions()
@NotNull MediaArgs.PictureSource @Nullable []	getPictureSources()
boolean	isAutoCrop()

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaComponentPropertyResolver

public MediaComponentPropertyResolver(@NotNull
                                      @NotNull org.apache.sling.api.resource.Resource resource,
                                      @NotNull
                                      @NotNull io.wcm.wcm.commons.component.ComponentPropertyResolverFactory componentPropertyResolverFactory)

Parameters:

resource - Resource

componentPropertyResolverFactory - Component property resolver factory

MediaComponentPropertyResolver

@Deprecated
public MediaComponentPropertyResolver(@NotNull
                                      @NotNull org.apache.sling.api.resource.Resource resource)

Deprecated.

Please use MediaComponentPropertyResolver(Resource, ComponentPropertyResolverFactory)

Parameters:

resource - Resource

Method Detail

isAutoCrop

public boolean isAutoCrop()

Returns:

AutoCrop state

getMediaFormatOptions

@NotNull
public @NotNull MediaArgs.MediaFormatOption @Nullable [] getMediaFormatOptions()

Returns:

List of media formats with and without mandatory setting.

getMediaFormatNames

@NotNull
public @NotNull String @Nullable [] getMediaFormatNames()

Returns:

List of media formats with and without mandatory setting.

getMandatoryMediaFormatNames

@NotNull
public @NotNull String @Nullable [] getMandatoryMediaFormatNames()

Returns:

List of media formats with and without mandatory setting.

getImageSizes

@Nullable
public @Nullable MediaArgs.ImageSizes getImageSizes()

Returns:

Image sizes

getPictureSources

@NotNull
public @NotNull MediaArgs.PictureSource @Nullable [] getPictureSources()

Returns:

List of picture sources

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception