com.rightware.kanzi

Class KanziResourceFile

java.lang.Object

com.rightware.kanzi.KanziResourceFile

public class KanziResourceFile
extends java.lang.Object

This singleton class handles file access to APK assets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KanziResourceFile.ResourceFile

Method Summary

Modifier and Type	Method and Description
void	APKCloseFile(KanziResourceFile.ResourceFile file) Closes the input stream in given ResourceFile and releases associated resources.
long	APKGetFileLength(KanziResourceFile.ResourceFile file) Returns the total number of bytes of ResourceFile's data.
KanziResourceFile.ResourceFile	APKOpenFile(java.lang.String filename) Creates a ResourceFile object containing an open InputStream for the given filename in context set by setContext(Context).
long	APKReadFile(KanziResourceFile.ResourceFile file, int size) Reads the specified number of bytes from a given ResourceFile.
long	APKSkipFile(KanziResourceFile.ResourceFile file, int offset) Skips over and discards a number bytes of data from ResourceFile's input stream.
Context	getContext() Returns the context which have been set using setContext(Context).
static KanziResourceFile	getInstance() Returns an instance of KanziResourceFile.
void	setContext(Context context) Sets the context of KanziResourceFile.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static KanziResourceFile getInstance()

Returns an instance of KanziResourceFile. Before using the returned instance for the first time, context has to be set once using setContext(Context). Context defaults to null and APKOpenFile(String) requests will fail until set.

Returns:

Singleton instance.

setContext

public void setContext(Context context)

Sets the context of KanziResourceFile.

Parameters:

context - The application's context utilizing KanziResourceFile's services.

getContext

public Context getContext()

Returns the context which have been set using setContext(Context).

Returns:

context

APKOpenFile

public KanziResourceFile.ResourceFile APKOpenFile(java.lang.String filename)

Creates a ResourceFile object containing an open InputStream for the given filename in context set by setContext(Context).

Parameters:

filename - A resource file in APK to be opened.

Returns:

ResourceFile for reading. Null when request failed and reading is not possible.

APKReadFile

public long APKReadFile(KanziResourceFile.ResourceFile file,
                        int size)

Reads the specified number of bytes from a given ResourceFile. Reallocates the byte buffer in ResourceFile to size bytes, if requested size is larger than the previously allocated size of ResourceFile.

Parameters:

file - ResourceFile with open InputStream to read.

size - Read buffer size in bytes.

Returns:

Number of bytes read. KZS_RESOURCE_FILE_ERROR on error. KZS_RESOURCE_FILE_EOF when end of file reached.

APKSkipFile

public long APKSkipFile(KanziResourceFile.ResourceFile file,
                        int offset)

Skips over and discards a number bytes of data from ResourceFile's input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned. If offset is negative, this method returns 0, and no bytes are skipped.

Parameters:

file - ResourceFile to read.

offset - Number of bytes to skip.

Returns:

The actual number of bytes skipped.

APKGetFileLength

public long APKGetFileLength(KanziResourceFile.ResourceFile file)

Returns the total number of bytes of ResourceFile's data. May be AssetFileDescriptor#UNKNOWN_LENGTH if the asset extends to the end of the file.

Parameters:

file - ResourceFile to query.

Returns:

File length in bytes. KZS_RESOURCE_FILE_ERROR for unopened. UNKNOWN_LENGTH is possible.

APKCloseFile

public void APKCloseFile(KanziResourceFile.ResourceFile file)

Closes the input stream in given ResourceFile and releases associated resources.

Parameters:

file - ResourceFile to close.