Package com.microej.wear.services

Interface ExternalResourceService

public interface ExternalResourceService

This service allows Features to create and delete external resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExternalResourceService.ImageFormat	Enumerates supported image formats.
static interface	ExternalResourceService.Writer	Represents a writer to an external resource.

Method Summary

Modifier and Type	Method	Description
ExternalResourceService.Writer	createExternalImage(String path, int size, ExternalResourceService.ImageFormat imageFormat)	Creates an external image at the given path, converting it to the given format.
ExternalResourceService.Writer	createExternalResource(String path, int size)	Creates an external resource at the given path.
boolean	deleteExternalResource(String path)	Deletes the external resource at the given path.
String	getExternalResourcePath(String path)	Returns the path to an external resource.

Method Detail

createExternalResource

ExternalResourceService.Writer createExternalResource(String path,
                                                      int size)
                                               throws IOException

Creates an external resource at the given path.

Parameters:

path - the path of the external resource (relative to the Module directory).

size - the size of the data to be written to the external resource.

Returns:

a writer to the external resource.

Throws:

IllegalArgumentException - if the path does not start with a "/".

IllegalArgumentException - if the size is negative.

IOException - if an external resource with the same path already exists.

IOException - if a writer to the same path is already opened.

IOException - if there is not enough memory in the external resource location to allocate the resource.

createExternalImage

ExternalResourceService.Writer createExternalImage(String path,
                                                   int size,
                                                   ExternalResourceService.ImageFormat imageFormat)
                                            throws IOException

Creates an external image at the given path, converting it to the given format.

Parameters:

path - the path of the external resource (relative to the Module directory).

size - the size of the data to be written to the external resource.

imageFormat - the format to convert the image to.

Returns:

a writer to the external resource.

Throws:

IllegalArgumentException - if the path does not start with a "/".

IllegalArgumentException - if the size is negative.

IOException - if an external resource with the same path already exists.

IOException - if a writer to the same path is already opened.

IOException - if there is not enough memory in the external resource location to allocate the resource.

deleteExternalResource

boolean deleteExternalResource(String path)
                        throws IOException

Deletes the external resource at the given path.

Parameters:

path - the path of the external resource (relative to the Module directory).

Returns:

true if the resource was successfully deleted, false if no resource exists at the given path.

Throws:

IllegalArgumentException - if the path does not start with a "/".

IOException - if an error occurs while deleting the resource.

IOException - if a writer to the resource is currently open.

getExternalResourcePath

String getExternalResourcePath(String path)

Returns the path to an external resource.

Parameters:

path - a path relative to the current context.

Returns:

the corresponding resource path.