BmpImage

Inheritance: java.lang.Object, com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

public final class BmpImage extends RasterImageResourceBase

Represents one image in BMP (BitMap Picture) format with its metadata and additional methods

Constructors

Constructor Description
BmpImage(String name, String contentInBase64) Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name
BmpImage(String name, InputStream binaryContent) Creates new BmpImage instance from content, represented as byte stream, and with specified name

Methods

Method Description
isValid(InputStream binaryContent) Checks whether specified stream is a valid BMP image
isValid(String contentInBase64) Checks whether specified base64-encoded string is a valid BMP image
getType() Returns ImageType.Bmp
reduceToNewHeight(int targetHeightInPixels) Creates and returns a new reduced BMP image, but with specified new reduced height and proportionally reduced width.

BmpImage(String name, String contentInBase64)

public BmpImage(String name, String contentInBase64)

Creates new BmpImage instance from content, represented as base64-encoded string, and with specified name

Parameters:

Parameter Type Description
name java.lang.String Name of the BMP image. Cannot be null, empty or whitespaces.
contentInBase64 java.lang.String Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a BMP content, exception will be thrown.

BmpImage(String name, InputStream binaryContent)

public BmpImage(String name, InputStream binaryContent)

Creates new BmpImage instance from content, represented as byte stream, and with specified name

Parameters:

Parameter Type Description
name java.lang.String Name of the BMP image. Cannot be null, empty or whitespaces.
binaryContent java.io.InputStream Content as byte stream. Reading begins from original position. Cannot be null. Should be readable and seekable. If this instance will be disposed, this stream will be disposed too.

isValid(InputStream binaryContent)

public static boolean isValid(InputStream binaryContent)

Checks whether specified stream is a valid BMP image

Parameters:

Parameter Type Description
binaryContent java.io.InputStream Byte stream, that presumably contains a BMP image

Returns: boolean - True if specified stream contains valid BMP image, false otherwise

isValid(String contentInBase64)

public static boolean isValid(String contentInBase64)

Checks whether specified base64-encoded string is a valid BMP image

Parameters:

Parameter Type Description
contentInBase64 java.lang.String Content of the presumably BMP image in a form of base64-encoded string

Returns: boolean - True if specified string contains valid BMP image, false otherwise

getType()

public ImageType getType()

Returns ImageType.Bmp

Returns: ImageType

reduceToNewHeight(int targetHeightInPixels)

public final BmpImage reduceToNewHeight(int targetHeightInPixels)

Creates and returns a new reduced BMP image, but with specified new reduced height and proportionally reduced width.

Parameters:

Parameter Type Description
targetHeightInPixels int Height of the desired BMP image in pixels. Should be strictly lesser than original height.

Returns: BmpImage - New BmpImage instance with specified height