com.foreach.imageserver.dto

Class ImageConvertDto

java.lang.Object

com.foreach.imageserver.dto.ImageConvertDto

public class ImageConvertDto
extends Object

DTO used when converting an image into 1 or multiple transformations

Since:

5.0.0

Author:

Wouter Van Hecke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageConvertDto.ImageConvertDtoBuilder

Constructor Summary

Constructors

Constructor and Description
ImageConvertDto()
ImageConvertDto(byte[] image, String imageId, String pages, Map<String,List<ImageTransformDto>> transformations)

Method Summary

Modifier and Type	Method and Description
static ImageConvertDto.ImageConvertDtoBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
byte[]	getImage() The image that we want to transform.
String	getImageId() Id of the registered image that we want to transform.
String	getPages() Which page number / scene numbers do we want to transform?
Map<String,List<ImageTransformDto>>	getTransformations() A collection of transformations we want to perform on the image.
int	hashCode()
void	setImage(byte[] image) The image that we want to transform.
void	setImageId(String imageId) Id of the registered image that we want to transform.
void	setPages(String pages) Which page number / scene numbers do we want to transform?
void	setTransformations(Map<String,List<ImageTransformDto>> transformations) A collection of transformations we want to perform on the image.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageConvertDto

public ImageConvertDto()

ImageConvertDto

public ImageConvertDto(byte[] image,
                       String imageId,
                       String pages,
                       Map<String,List<ImageTransformDto>> transformations)

Method Detail

builder

public static ImageConvertDto.ImageConvertDtoBuilder builder()

getImage

public byte[] getImage()

The image that we want to transform. Either this property or imageId should be set (to convert a registered image).

getImageId

public String getImageId()

Id of the registered image that we want to transform. Either this property or image bytes should be set.

getPages

public String getPages()

Which page number / scene numbers do we want to transform?

Value can be a number (1), a range (3-6) and multiple numbers can be seperated using a comma. For example: value "1,4-6" will return page 1, 4 and 5. This index is 0-based (so number 0 will return page 1)

getTransformations

public Map<String,List<ImageTransformDto>> getTransformations()

A collection of transformations we want to perform on the image.

Every entry consists of a key and a list of transformations.

The key can be used to identify the correct image in the response. In the key, you can use the wildcard *. This value will be replaced with the page number in the returning key. So if you supply "flower-*" as key and you convert page 1 and 2, the response will contain an image with key "flower-1" and "flower-2".

The list of transformations contains of all the transformations you want to execute on the image. These will be executed in the supplied order.

setImage

public void setImage(byte[] image)

The image that we want to transform. Either this property or imageId should be set (to convert a registered image).

setImageId

public void setImageId(String imageId)

Id of the registered image that we want to transform. Either this property or image bytes should be set.

setPages

public void setPages(String pages)

Which page number / scene numbers do we want to transform?

Value can be a number (1), a range (3-6) and multiple numbers can be seperated using a comma. For example: value "1,4-6" will return page 1, 4 and 5. This index is 0-based (so number 0 will return page 1)

setTransformations

public void setTransformations(Map<String,List<ImageTransformDto>> transformations)

A collection of transformations we want to perform on the image.

Every entry consists of a key and a list of transformations.

The key can be used to identify the correct image in the response. In the key, you can use the wildcard *. This value will be replaced with the page number in the returning key. So if you supply "flower-*" as key and you convert page 1 and 2, the response will contain an image with key "flower-1" and "flower-2".

The list of transformations contains of all the transformations you want to execute on the image. These will be executed in the supplied order.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object