Package io.wcm.handler.media
Class Media
- java.lang.Object
-
- io.wcm.handler.media.Media
-
@ProviderType public final class Media extends java.lang.Object
Holds information about a media request processed and resolved byMediaHandler
.
-
-
Constructor Summary
Constructors Constructor Description Media(@NotNull MediaSource mediaSource, @NotNull MediaRequest mediaRequest)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @Nullable Asset
getAsset()
Get media item info that was resolved during media handler processing@Nullable CropDimension
getCropDimension()
@Nullable io.wcm.handler.commons.dom.HtmlElement
getElement()
@Nullable java.util.List<ImageMapArea>
getMap()
@Nullable java.lang.String
getMarkup()
@Nullable MediaInvalidReason
getMediaInvalidReason()
@Nullable java.lang.String
getMediaInvalidReasonCustomMessage()
@NotNull MediaRequest
getMediaRequest()
@NotNull MediaSource
getMediaSource()
@Nullable Rendition
getRendition()
Get first (and best-match) rendition that was resolved during media handler processing@NotNull java.util.Collection<Rendition>
getRenditions()
Get all renditions that were resolved during media handler processing@Nullable java.lang.Integer
getRotation()
@Nullable java.lang.String
getUrl()
boolean
isValid()
void
setAsset(@Nullable Asset asset)
Set media item that was resolved during media handler processingvoid
setCropDimension(@Nullable CropDimension cropDimension)
void
setElementBuilder(@NotNull java.util.function.Function<Media,io.wcm.handler.commons.dom.HtmlElement> value)
void
setMap(@Nullable java.util.List<ImageMapArea> map)
void
setMediaInvalidReason(@Nullable MediaInvalidReason mediaInvalidReason)
void
setMediaInvalidReasonCustomMessage(@Nullable java.lang.String mediaInvalidReasonCustomMessage)
void
setMediaRequest(@NotNull MediaRequest mediaRequest)
void
setRenditions(@Nullable java.util.Collection<Rendition> renditions)
Set all renditions that was resolved during media handler processingvoid
setRotation(@Nullable java.lang.Integer rotation)
void
setUrl(@Nullable java.lang.String value)
java.lang.String
toString()
-
-
-
Constructor Detail
-
Media
public Media(@NotNull @NotNull MediaSource mediaSource, @NotNull @NotNull MediaRequest mediaRequest)
- Parameters:
mediaSource
- Media sourcemediaRequest
- Processed media request
-
-
Method Detail
-
getMediaSource
@NotNull public @NotNull MediaSource getMediaSource()
- Returns:
- Media source
-
getMediaRequest
@NotNull public @NotNull MediaRequest getMediaRequest()
- Returns:
- Media handling request
-
setMediaRequest
public void setMediaRequest(@NotNull @NotNull MediaRequest mediaRequest)
- Parameters:
mediaRequest
- Media handling request
-
getElement
@Nullable public @Nullable io.wcm.handler.commons.dom.HtmlElement getElement()
- Returns:
- Html element
-
getMarkup
@Nullable public @Nullable java.lang.String getMarkup()
- Returns:
- Media HTML element serialized to string. Returns null if media element is null.
-
setElementBuilder
public void setElementBuilder(@NotNull @NotNull java.util.function.Function<Media,io.wcm.handler.commons.dom.HtmlElement> value)
- Parameters:
value
- Function that builds the HTML element representation on demand
-
getUrl
@Nullable public @Nullable java.lang.String getUrl()
- Returns:
- Media URL
-
setUrl
public void setUrl(@Nullable @Nullable java.lang.String value)
- Parameters:
value
- Media URL
-
getAsset
@Nullable public @Nullable Asset getAsset()
Get media item info that was resolved during media handler processing- Returns:
- Media item
-
setAsset
public void setAsset(@Nullable @Nullable Asset asset)
Set media item that was resolved during media handler processing- Parameters:
asset
- Media item
-
getRendition
@Nullable public @Nullable Rendition getRendition()
Get first (and best-match) rendition that was resolved during media handler processing- Returns:
- Rendition
-
getRenditions
@NotNull public @NotNull java.util.Collection<Rendition> getRenditions()
Get all renditions that were resolved during media handler processing- Returns:
- Renditions
-
setRenditions
public void setRenditions(@Nullable @Nullable java.util.Collection<Rendition> renditions)
Set all renditions that was resolved during media handler processing- Parameters:
renditions
- Renditions
-
getCropDimension
@Nullable public @Nullable CropDimension getCropDimension()
- Returns:
- Crop dimensions (optional)
-
setCropDimension
public void setCropDimension(@Nullable @Nullable CropDimension cropDimension)
- Parameters:
cropDimension
- Crop dimensions (optional)
-
getRotation
@Nullable public @Nullable java.lang.Integer getRotation()
- Returns:
- Image rotation (optional)
-
setRotation
public void setRotation(@Nullable @Nullable java.lang.Integer rotation)
- Parameters:
rotation
- Image Rotation (optional)
-
getMap
@Nullable public @Nullable java.util.List<ImageMapArea> getMap()
- Returns:
- Image map (optional)
-
setMap
public void setMap(@Nullable @Nullable java.util.List<ImageMapArea> map)
- Parameters:
map
- Image map (optional)
-
isValid
public boolean isValid()
- Returns:
- true if link is valid and was resolved successfully
-
getMediaInvalidReason
@Nullable public @Nullable MediaInvalidReason getMediaInvalidReason()
- Returns:
- Reason why the requested media could not be resolved and is invalid
-
setMediaInvalidReason
public void setMediaInvalidReason(@Nullable @Nullable MediaInvalidReason mediaInvalidReason)
- Parameters:
mediaInvalidReason
- Reason why the requested media could not be resolved and is invalid
-
getMediaInvalidReasonCustomMessage
@Nullable public @Nullable java.lang.String getMediaInvalidReasonCustomMessage()
- Returns:
- Custom message when
getMediaInvalidReason()
is set toMediaInvalidReason.CUSTOM
. Message is interpreted as i18n key.
-
setMediaInvalidReasonCustomMessage
public void setMediaInvalidReasonCustomMessage(@Nullable @Nullable java.lang.String mediaInvalidReasonCustomMessage)
- Parameters:
mediaInvalidReasonCustomMessage
- Custom message whengetMediaInvalidReason()
is set toMediaInvalidReason.CUSTOM
. Message is interpreted as i18n key.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-