org.eclipse.mtj.core.symbol
Interface ISymbolSetFactory

public interface ISymbolSetFactory

This API provides a mechanism to create symbols set. Two different ways are available: create from a device and create from a j2mepolish device file. The first one will be based on the device properties and the device libraries. The later is based on j2mepolish device format and will create an array of symbol sets for each device that is available on the database

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the MTJ team.

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

Field Summary

static String	DEVICE_DB_J2MEPOLISH_FILE Constant that represents the type j2mepolish from file
static String	DEVICE_DB_J2MEPOLISH_JAR Constant that represents the type j2mepolish from antenna jar

Method Summary

ISymbol	createSymbol(String name, String value) Creates a new symbol based on the symbol name and value
ISymbolSet	createSymbolSet(String name) Create a symbol set with a predefined name
List<ISymbolSet>	createSymbolSetFromDataBase(String type, URI input, IProgressMonitor monitor) Creates a list of symbol sets based on a device data base. the device database is specified via an input URI and a type.
ISymbolSet	createSymbolSetFromDevice(IDevice device) Create SymbolSet from device.

Field Detail

DEVICE_DB_J2MEPOLISH_JAR

static final String DEVICE_DB_J2MEPOLISH_JAR

Constant that represents the type j2mepolish from antenna jar

See Also:

Constant Field Values

DEVICE_DB_J2MEPOLISH_FILE

static final String DEVICE_DB_J2MEPOLISH_FILE

Constant that represents the type j2mepolish from file

See Also:

Constant Field Values

Method Detail

createSymbolSetFromDataBase

List<ISymbolSet> createSymbolSetFromDataBase(String type,
                                             URI input,
                                             IProgressMonitor monitor)
                                             throws IOException

Creates a list of symbol sets based on a device data base. the device database is specified via an input URI and a type. Currently MTJ supports only J2MEPolish database

Parameters:

type - a string that represents the type of the database to be imported

input - input URI of where the database is

monitor - Progress monitor, inform user about process of import. Null is allowed.

Returns:

List of symbol set

Throws:

IOException

createSymbolSetFromDevice

ISymbolSet createSymbolSetFromDevice(IDevice device)

Create SymbolSet from device. The content of the symbolset will be based on the device properties and also on the libraries that the device has

Parameters:

device -

Returns:

created symbol set

createSymbolSet

ISymbolSet createSymbolSet(String name)

Create a symbol set with a predefined name

Parameters:

name - symbol set name

Returns:

created symbol set

createSymbol

ISymbol createSymbol(String name,
                     String value)

Creates a new symbol based on the symbol name and value

Parameters:

name - symbol name

value - symbol value

Returns:

ISymbol that was just created