io.github.antoniovizuete.pojospreadsheet.core.image

Interface Image

All Known Implementing Classes:

ImageInputStream

public interface Image

Interface indicating the basic members of an Image.

Since:

0.1

Author:

Antonio Vizuete

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Image.ImageType The enum 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	setType(Image.ImageType type) Set the Image.ImageType of an Image.
Image	type(Image.ImageType type) "Builder-Look" method.

Method Detail

getCellAddress

CellAddress getCellAddress()

Return the CellAddress of an Image.

Returns:

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

getType

Image.ImageType getType()

Return the Image.ImageType of an Image.

Returns:

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

setType

void setType(Image.ImageType type)

Set the Image.ImageType of an Image.

Parameters:

type - the type

address

Image address(CellAddress cellAddress)

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

Set the CellAddress.

And it returns the instance.

Parameters:

cellAddress - the address

Returns:

the instance of current object (Image)

type

Image type(Image.ImageType type)

"Builder-Look" method.

Set the Image.ImageType of an Image.

And it returns the instance.

Parameters:

type - the image type

Returns:

the instance of current object (Image)

getResource

byte[] getResource()
            throws IOException

The method returns the Image resource converted into byte array.

Returns:

Image byte array, or byte[0] if none

Throws:

IOException - treats the resource