Package io.wcm.handler.media

Class MediaArgs.PictureSource

java.lang.Object

io.wcm.handler.media.MediaArgs.PictureSource

Enclosing class:

MediaArgs

@ProviderType
public static final class MediaArgs.PictureSource
extends Object

Picture source for responsive image handling.

Constructor Summary

Constructors

Constructor	Description
PictureSource(@NotNull MediaFormat mediaFormat)
PictureSource(@NotNull MediaFormat mediaFormat, @Nullable String media, long @NotNull ... widths)	Deprecated. Use constructor with MediaFormat and media and widths(long...).
PictureSource(@Nullable MediaFormat mediaFormat, @Nullable String media, @NotNull MediaArgs.WidthOption @NotNull ... widthOptions)	Deprecated. Use constructor with MediaFormat and media and widths(long...).
PictureSource(@Nullable String mediaFormatName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@Nullable String	getMedia()
@Nullable MediaFormat	getMediaFormat()
@Nullable String	getMediaFormatName()
@Nullable String	getSizes()
@NotNull MediaArgs.WidthOption @Nullable []	getWidthOptions()
long @Nullable []	getWidths()	Deprecated. Use getWidthOptions()
int	hashCode()
MediaArgs.PictureSource	media(@Nullable String value)
MediaArgs.PictureSource	sizes(@Nullable String value)
String	toString()
MediaArgs.PictureSource	widthOptions(@NotNull MediaArgs.WidthOption @NotNull ... value)
MediaArgs.PictureSource	widths(long @NotNull ... value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PictureSource

public PictureSource(@NotNull
                     @NotNull MediaFormat mediaFormat)

Parameters:

mediaFormat - Media format

PictureSource

public PictureSource(@Nullable
                     @Nullable String mediaFormatName)

Parameters:

mediaFormatName - Media format name

PictureSource

@Deprecated
public PictureSource(@NotNull
                     @NotNull MediaFormat mediaFormat,
                     @Nullable
                     @Nullable String media,
                     long @NotNull ... widths)

Deprecated.

Use constructor with MediaFormat and media and widths(long...).

Parameters:

mediaFormat - Media format

media - A valid media query list

widths - Widths for the renditions in the srcset attribute (all mandatory).

PictureSource

@Deprecated
public PictureSource(@Nullable
                     @Nullable MediaFormat mediaFormat,
                     @Nullable
                     @Nullable String media,
                     @NotNull
                     @NotNull MediaArgs.WidthOption @NotNull ... widthOptions)

Deprecated.

Use constructor with MediaFormat and media and widths(long...).

Parameters:

mediaFormat - Media format

media - A valid media query list

widthOptions - Widths for the renditions in the srcset attribute.

Method Detail

getMediaFormat

@Nullable
public @Nullable MediaFormat getMediaFormat()

Returns:

Media format

getMediaFormatName

@Nullable
public @Nullable String getMediaFormatName()

Returns:

Media format

widthOptions

public MediaArgs.PictureSource widthOptions(@NotNull
                                            @NotNull MediaArgs.WidthOption @NotNull ... value)

Parameters:

value - Widths for the renditions in the srcset attribute.

Returns:

this

getWidthOptions

@NotNull
public @NotNull MediaArgs.WidthOption @Nullable [] getWidthOptions()

Returns:

Widths for the renditions in the srcset attribute.

widths

public MediaArgs.PictureSource widths(long @NotNull ... value)

Parameters:

value - Widths for the renditions in the srcset attribute.

Returns:

this

getWidths

@Deprecated
public long @Nullable [] getWidths()

Deprecated.

Use getWidthOptions()

Returns:

Widths for the renditions in the srcset attribute.

sizes

public MediaArgs.PictureSource sizes(@Nullable
                                     @Nullable String value)

Parameters:

value - A valid source size list.

Returns:

this

getSizes

@Nullable
public @Nullable String getSizes()

Returns:

A valid source size list.

media

public MediaArgs.PictureSource media(@Nullable
                                     @Nullable String value)

Parameters:

value - A valid media query list.

Returns:

this

getMedia

@Nullable
public @Nullable String getMedia()

Returns:

A valid media query list.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object