org.eclipse.mtj.core.symbol
Interface ISymbolSetRegistry

All Superinterfaces:

IPersistable

public interface ISymbolSetRegistry
extends IPersistable

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.

Method Summary

void	addSymbolSet(ISymbolSet definitions) Add the specified SymbolDefinitions object to the registry of definitions.
void	addSymbolSet(List<ISymbolSet> ss) Add an array of symbol sets to the registry
void	addSymbolSetChangeListener(ISymbolSetChangeListener listener)
void	clear() Clear all of the registered SymbolDefinitions objects.
String[]	getAllSymbolSetNames() Return all of the definition names registered.
ISymbolSet[]	getAllSymbolSets() Return all of the definitions registered.
ISymbolSet	getSymbolSet(String name) Return the SymbolDefinitions instance registered with the specified name or null if the object cannot be found.
void	load() Load the contents of the symbol definitions registry from the storage file in the plug-in state location.
void	removeSymbolSet(String setName) Remove the specified definition set from the registry.
void	removeSymbolSetChangeListener(ISymbolSetChangeListener listener)
void	store() Store out the contents of the registry into the standard device storage file in the plug-in state location.

Methods inherited from interface org.eclipse.mtj.core.persistence.IPersistable

loadUsing, storeUsing

Method Detail

addSymbolSet

void addSymbolSet(ISymbolSet definitions)
                  throws PersistenceException

Add the specified SymbolDefinitions object to the registry of definitions.

Parameters:

definitions -

Throws:

PersistenceException

IllegalStateException - if the provided definition set has a null name.

addSymbolSet

void addSymbolSet(List<ISymbolSet> ss)
                  throws PersistenceException

Add an array of symbol sets to the registry

Parameters:

ss - symbol set array

Throws:

PersistenceException

addSymbolSetChangeListener

void addSymbolSetChangeListener(ISymbolSetChangeListener listener)

Parameters:

listener -

clear

void clear()
           throws PersistenceException

Clear all of the registered SymbolDefinitions objects.

Throws:

PersistenceException

getAllSymbolSetNames

String[] getAllSymbolSetNames()
                              throws PersistenceException

Return all of the definition names registered.

Returns:

Throws:

PersistenceException

getAllSymbolSets

ISymbolSet[] getAllSymbolSets()
                              throws PersistenceException

Return all of the definitions registered.

Returns:

Throws:

PersistenceException

getSymbolSet

ISymbolSet getSymbolSet(String name)
                        throws PersistenceException

Return the SymbolDefinitions instance registered with the specified name or null if the object cannot be found.

Parameters:

name -

Returns:

Throws:

PersistenceException

removeSymbolSet

void removeSymbolSet(String setName)

Remove the specified definition set from the registry. Does nothing if the specified set cannot be found in the registry.

Parameters:

setName -

removeSymbolSetChangeListener

void removeSymbolSetChangeListener(ISymbolSetChangeListener listener)

Parameters:

listener -

load

void load()
          throws PersistenceException

Load the contents of the symbol definitions registry from the storage file in the plug-in state location.

Throws:

PersistenceException

store

void store()
           throws PersistenceException,
                  TransformerException,
                  IOException

Store out the contents of the registry into the standard device storage file in the plug-in state location.

Throws:

PersistenceException

TransformerException

IOException