hr.ngs.templater

Class ImageInfo

java.lang.Object

hr.ngs.templater.ImageInfo

public final class ImageInfo
extends java.lang.Object

Special image type.

To easily support passing in image and their DPI information (which is not easily extracted in Java) this special type is recognized and processed by Templater implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageInfo.Builder ImageInfo builder for easier initialization.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	content Image content as stored on disk
java.lang.String	extension Extension to use (eg: png, gif, jpg,...)
int	height Height of the image, eg: 400
float	horizontalResolution Horizontal DPI of the image, eg: 96
float	verticalResolution Vertical DPI of the image, eg: 96
int	width Width of the image, eg: 600

Constructor Summary

Constructors

Constructor and Description
ImageInfo(byte[] content, java.lang.String extension, int width, float horizontalResolution, int height, float verticalResolution) Full ImageInfo constructor where horizontal and vertical DPI can be different
ImageInfo(byte[] content, java.lang.String extension, int width, int height, float resolution) Basic ImageInfo constructor with same horizontal and vertical DPI

Method Summary

Modifier and Type	Method and Description
static ImageInfo.Builder	from(byte[] content) ImageInfo builder from byte array
static ImageInfo.Builder	from(java.io.InputStream stream) ImageInfo builder from a stream.

Methods inherited from class java.lang.Object

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

Field Detail

content

public final byte[] content

Image content as stored on disk

extension

public final java.lang.String extension

Extension to use (eg: png, gif, jpg,...)

width

public final int width

Width of the image, eg: 600

horizontalResolution

public final float horizontalResolution

Horizontal DPI of the image, eg: 96

height

public final int height

Height of the image, eg: 400

verticalResolution

public final float verticalResolution

Vertical DPI of the image, eg: 96

Constructor Detail

ImageInfo

public ImageInfo(byte[] content,
                 java.lang.String extension,
                 int width,
                 int height,
                 float resolution)

Basic ImageInfo constructor with same horizontal and vertical DPI

Parameters:

content - content as saved on disk

extension - filename extension (eg, png, jpg, ...)

width - image width

height - image height

resolution - DPI

ImageInfo

public ImageInfo(byte[] content,
                 java.lang.String extension,
                 int width,
                 float horizontalResolution,
                 int height,
                 float verticalResolution)

Full ImageInfo constructor where horizontal and vertical DPI can be different

Parameters:

content - content as saved on disk

extension - filename extension (eg, png, jpg, ...)

width - image width

horizontalResolution - horizontal DPI

height - image height

verticalResolution - vertical DPI

Method Detail

from

public static ImageInfo.Builder from(byte[] content)

ImageInfo builder from byte array

Parameters:

content - disk representation of an image

Returns:

builder

from

public static ImageInfo.Builder from(java.io.InputStream stream)
                              throws java.io.IOException

ImageInfo builder from a stream. It will be eagerly converted into byte array

Parameters:

stream - image content as stored on disk

Returns:

builder

Throws:

java.io.IOException - errors reading from stream