com.groupdocs.editor.htmlcss.resources.images.raster

Class IconImage

java.lang.Object

com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

com.groupdocs.editor.htmlcss.resources.images.raster.IconImage

All Implemented Interfaces:

IAuxDisposable, IHtmlResource, IImage, IImageResource, IDisposable

public final class IconImage
extends RasterImageResourceBase

Represents one image in ICON format with its metadata and additional methods

Field Summary

Fields inherited from class com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

_base64TextContent, _binaryContent, _isDisposed, _isOwnStream, _linearDimensions, _name, _streamOrigPosition, Disposed

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getNumberOfImages() Returns number of images, which are present in this ICON file
ImageType	getType() Returns ImageType.Icon
static boolean	isValid(InputStream binaryContent) Checks whether specified stream is a valid ICON image
static boolean	isValid(String contentInBase64) Checks whether specified base64-encoded string is a valid ICON image

Methods inherited from class com.groupdocs.editor.htmlcss.resources.images.raster.RasterImageResourceBase

dispose, equals, getAspectRatio, getByteContent, getFilenameWithExtension, getLength, getLinearDimensions, getName, getTextContent, isDisposed, save

Methods inherited from class java.lang.Object

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

Constructor Detail

IconImage

public IconImage(String name,
                 InputStream binaryContent)

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

Parameters:

name - Name of the ICON image. Cannot be null, empty or whitespaces.

binaryContent - 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.

Throws:

IllegalArgumentException

InvalidImageFormatException

IconImage

public IconImage(String name,
                 String contentInBase64)

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

Parameters:

name - Name of the ICON image. Cannot be null, empty or whitespaces.

contentInBase64 - Content as base64-encoded string. Cannot be null, empty or whitespaces. If it is not a ICON content, exception will be thrown.

Throws:

IllegalArgumentException

InvalidImageFormatException

Method Detail

getNumberOfImages

public final int getNumberOfImages()

Returns number of images, which are present in this ICON file

getType

public ImageType getType()

Returns ImageType.Icon

Specified by:

getType in interface IHtmlResource

Specified by:

getType in interface IImageResource

Specified by:

getType in class RasterImageResourceBase

Returns:

isValid

public static boolean isValid(InputStream binaryContent)

Checks whether specified stream is a valid ICON image

Parameters:

binaryContent - Byte stream, that presumably contains a ICON image

Returns:

True if specified stream contains valid ICON image, false otherwise

isValid

public static boolean isValid(String contentInBase64)

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

Parameters:

contentInBase64 - Content of the presumably ICON image in a form of base64-encoded string

Returns:

True if specified string contains valid ICON image, false otherwise