com.day.cq.dam.commons.thumbnail

Class ThumbnailGenerator

java.lang.Object

com.day.cq.dam.commons.thumbnail.ThumbnailGenerator

Deprecated.

since 6.0, use RenditionMaker service instead

@Deprecated
public class ThumbnailGenerator
extends Object

Generates thumbnails for the given Asset and its graphical representation in the form of a BufferedImage. Thumbnails are generated based on a collection of ThumbnailConfigs.

Since:

CQ 5.4.0

See Also:

ThumbnailConfig

Constructor Summary

Constructors

Constructor and Description
ThumbnailGenerator(Asset asset, BufferedImage image) Deprecated. since 6.0, use RenditionMaker service instead

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(Collection<ThumbnailConfig> configs) Deprecated. since 6.0, use RenditionMaker service instead
static Collection<ThumbnailConfig>	getConfigs(Collection<Integer[]> dimensions) Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service
static ThumbnailConfig	parseConfig(String str) Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service
static Collection<ThumbnailConfig>	parseConfig(String[] args) Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service

Methods inherited from class java.lang.Object

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

Constructor Detail

ThumbnailGenerator

@Deprecated
public ThumbnailGenerator(Asset asset,
                             BufferedImage image)

Deprecated. since 6.0, use RenditionMaker service instead

Constructor for the ThumbnailGenerator.

Parameters:

asset - The Asset for which thumbnails shall be generated.

image - The BufferedImage serving as the graphical representation of the asset, from which thumbnails are generated.

Method Detail

generate

@Deprecated
public void generate(Collection<ThumbnailConfig> configs)
              throws IOException,
                     RepositoryException

Deprecated. since 6.0, use RenditionMaker service instead

This method creates the thumbnails denoted by the given configs and stores it as Renditions on the asset. Thumbnails are saved in batch mode to the asset.

Parameters:

configs - The thumbnail configurations.

Throws:

IOException - If an error occurred processing the image.

javax.jcr.RepositoryException - in case the thumbnails cannot be persisted

RepositoryException

parseConfig

@Deprecated
public static Collection<ThumbnailConfig> parseConfig(String[] args)

Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service

Parses multiple thumbnail configurations.

Parameters:

args - The configuration strings.

Returns:

A collection of parsed ThumbnailConfigs.

parseConfig

@Deprecated
public static ThumbnailConfig parseConfig(String str)

Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service

Parse a thumbnail configuration in the following formats:

    [width:height:doCenter]
      or
    [width:height]
      or
    width:height:doCenter
      or
    width:height
 

The configuration string must at least provide width and height. null is returned if an invalid configuration string is encountered, namely non-numeric width/height or insufficient arguments.

Parameters:

str - The configuration string.

Returns:

A thumbnail config or null if the configuration string is invalid.

getConfigs

@Deprecated
public static Collection<ThumbnailConfig> getConfigs(Collection<Integer[]> dimensions)

Deprecated. since 6.0, avoid thumbnail configuration in workflow processes, and use RenditionMaker service

Returns thumbnail configurations for an array of given dimensions.

Parameters:

dimensions - The dimensions.

Returns:

A collection of thumbnail configurations.