com.microej.tool.ui.generator

Interface ImageConverter

public interface ImageConverter

An implementation of this interface is required to convert a file in a format not managed by MicroUI (custom ouput format different than MicroUI RAW formats).

The generated file convert is not compatible with MicroUI API but it can be used by some custom MicroUI extensions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ImageConverter.OutputFile Specifies the generated file: its relative path from the output folder and its type.
static class	ImageConverter.OutputFileType Specifies the generated file's output type.

Method Summary

Modifier and Type	Method and Description
default ImageConverter.OutputFile	generate(Image image, java.io.File outputDir) Generates a file from the given file in the given output folder.
boolean	generate(Image image, java.io.OutputStream stream) Converts the given image in the given output stream.
default java.lang.String[]	getListFileExtensions() Gets the exhaustive list of the list file extensions supported by this converter.
java.lang.String	getOutputFileExtension() Returns the file extension to apply as suffix for the converted images.

Method Detail

generate

default ImageConverter.OutputFile generate(Image image,
                                           java.io.File outputDir)
                                    throws java.io.IOException

Generates a file from the given file in the given output folder.

This method allows to generate any types of file with any name.

By default, this method creates a file with the same relative path than input image plus the extension returned by getOutputFileExtension(). Then it call generate(Image, OutputStream). This simplifies the implementation that just needs to convert the input file and fill the file output stream.

Parameters:

image - the image to convert

outputDir - the output folder

Returns:

an output file when a file has been generated, null otherwise.

Throws:

java.io.IOException

generate

boolean generate(Image image,
                 java.io.OutputStream stream)
          throws java.io.IOException

Converts the given image in the given output stream.

If this method returns true, the image is considered as encoded even if no byte has been written into the output stream. In this case the final file size is 0.

If this method returns false, the image is not considered as encoded even if some bytes have been written into the output stream. In this case the written bytes are lost.

Parameters:

image - the image to convert

stream - the output stream where write the encoded image.

Returns:

true when the image has been converted.

Throws:

java.io.IOException

getOutputFileExtension

java.lang.String getOutputFileExtension()

Returns the file extension to apply as suffix for the converted images. At runtime, the converted image can be retrieved using the image classpath relative path (with its extension, for instance ".png") + this extension.

Returns:

the output file extension

getListFileExtensions

default java.lang.String[] getListFileExtensions()

Gets the exhaustive list of the list file extensions supported by this converter.

Only the files listed in a supported list file are given to this converter to be generated. The default extension (*.images.list) is implicitely added when no specific extension is returned (otherwise the default extension must be explicitely added).

Returns:

the list file extensions (with or without the first point '.') or an empty array (null accepted)