io.github.antoniovizuete.pojospreadsheet.core.image

Class ImageInputStream

java.lang.Object

io.github.antoniovizuete.pojospreadsheet.core.image.ImageInputStream

All Implemented Interfaces:

Image

public final class ImageInputStream
extends Object
implements Image

An Image implementation.

It represents an image to place into a SheetImpl. Requires the resource path.

Since:

0.1

Author:

Antonio Vizuete

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.antoniovizuete.pojospreadsheet.core.image.Image

Image.ImageType

Constructor Summary

Constructors

Constructor and Description
ImageInputStream(String path, CellAddress cellAddress)
ImageInputStream(String path, CellAddress cellAddress, Image.ImageType type)

Method Summary

Modifier and Type	Method and Description
Image	address(CellAddress cellAddress) "Builder-Look" method, set the address and return the .
CellAddress	getCellAddress() Return the CellAddress of an Image.
byte[]	getResource() The method returns the Image resource converted into byte array.
Image.ImageType	getType() Return the Image.ImageType of an Image.
void	setPath(String path) Sets the resource path.
void	setType(Image.ImageType type) Set the Image.ImageType of an Image.
String	toString()
Image	type(Image.ImageType type) "Builder-Look" method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.antoniovizuete.pojospreadsheet.core.image.Image

address, getCellAddress, getType, setType, type

Constructor Detail

ImageInputStream

public ImageInputStream(String path,
                        CellAddress cellAddress)

ImageInputStream

public ImageInputStream(String path,
                        CellAddress cellAddress,
                        Image.ImageType type)

Method Detail

getResource

public byte[] getResource()
                   throws IOException

Description copied from interface: Image

The method returns the Image resource converted into byte array.

Specified by:

getResource in interface Image

Returns:

Image byte array, or byte[0] if none

Throws:

IOException - treats the resource

setPath

public void setPath(String path)

Sets the resource path.

Parameters:

path - Path to image resource

toString

public String toString()

Overrides:

toString in class Object

address

public Image address(CellAddress cellAddress)

Description copied from interface: Image

"Builder-Look" method, set the address and return the .

Set the CellAddress.

And it returns the instance.

Specified by:

address in interface Image

Parameters:

cellAddress - the address

Returns:

the instance of current object (Image)

type

public Image type(Image.ImageType type)

Description copied from interface: Image

"Builder-Look" method.

Set the Image.ImageType of an Image.

And it returns the instance.

Specified by:

type in interface Image

Parameters:

type - the image type

Returns:

the instance of current object (Image)

getCellAddress

public CellAddress getCellAddress()

Description copied from interface: Image

Return the CellAddress of an Image.

Specified by:

getCellAddress in interface Image

Returns:

the CellAddress of an Image, or {@link CellAddress#empty()} if none

getType

public Image.ImageType getType()

Description copied from interface: Image

Return the Image.ImageType of an Image.

Specified by:

getType in interface Image

Returns:

Image.ImageType of an Image, or EXA.Spreadsheets.Image.Type.JPEG if none

setType

public void setType(Image.ImageType type)

Description copied from interface: Image

Set the Image.ImageType of an Image.

Specified by:

setType in interface Image

Parameters:

type - the type