com.microej.tool.ui.generator

Interface Image

public interface Image

Represents an image listed in a ".images.list" file. This image has to be converted in a binary format according the specified output format (see getOutputFormat() and the output format options (see getOptions()).

Method Summary

Modifier and Type	Method and Description
java.io.BufferedInputStream	getInputData() Returns a new BufferedInputStream on the image.
java.lang.String	getName() Returns the image name specified in ".images.list" file.
java.lang.String[]	getOptions() Returns the options specified in ".images.list" file.
java.lang.String	getOutputFormat() Returns the format specified in ".images.list" file.
java.lang.String	getRelativePath() Returns the relative path specified in ".images.list" file.

Method Detail

getInputData

java.io.BufferedInputStream getInputData()

Returns a new BufferedInputStream on the image.

First bytes can be read even if caller (implementation of ImageConverter is not able to decode the image (often the first image bytes must be read to know if the loader is able to decode the image).

Returns:

a new BufferedInputStream on the image.

getRelativePath

java.lang.String getRelativePath()

Returns the relative path specified in ".images.list" file.

Returns:

the image relative path.

getName

java.lang.String getName()

Returns the image name specified in ".images.list" file.

Returns:

the image relative name.

getOutputFormat

java.lang.String getOutputFormat()

Returns the format specified in ".images.list" file. More specifically, this format is the upper-case string of the format specified in list file.

Returns an empty string when the format is not specified.

Returns:

the expected image output format.

getOptions

java.lang.String[] getOptions()

Returns the options specified in ".images.list" file. Case is respected.

Returns an empty array when no option is specified.

Returns:

the output format options.