|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.neeve.root.RootObject
com.neeve.sma.SmaObject
com.neeve.sma.MessageViewFactoryDescriptor
public final class MessageViewFactoryDescriptor
A message view factory descriptor.
This class contains information to describe a message view factory. It also contains methods to persist and load view factory descriptors to/from X Platform configuration respositories.
Method Summary | |
---|---|
static MessageViewFactoryDescriptor |
create(String name,
short id,
String className)
Create an smaty message view factory descriptor. |
void |
delete(IConfigRepository repo)
Delete a message view factory descriptor from a configuration repository. |
static boolean |
exists(IConfigRepository repo,
String name)
Checks if a message view factory descriptor is present in a configuration repository. |
static boolean |
exists(String name)
Checks if a message view factory descriptor is present in the local configuration repository |
String |
getClassName()
Get the java class of the message view factory that this descriptor describes. |
short |
getId()
Get the id of the message view factory that this descriptor describes. |
String |
getName()
Get the name of the message view factory that this descriptor describes. |
static MessageViewFactoryDescriptor |
load(IConfigRepository repo,
String name)
Create a message view factory descriptor from a configuration repository. |
static MessageViewFactoryDescriptor |
load(String name)
Create a message view factory descriptor from the local configuration repository. |
static Map<Short,MessageViewFactoryDescriptor> |
loadAll()
Create message view factory descriptors for all factories in the local configuration repository. |
static Map<Short,MessageViewFactoryDescriptor> |
loadAll(IConfigRepository repo)
Create message view factory descriptors for all factories in a configuration repository. |
void |
save()
Save a message view factory descriptor to the defalt configuration repository. |
void |
save(IConfigRepository repo)
Save a message view factory descriptor to a configuration repository. |
String |
toString()
Returns a string representation of this object |
Methods inherited from class com.neeve.root.RootObject |
---|
getChecked, getThreaded, getTracer, setChecked, setTracer |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public final String getName()
public final short getId()
public final String getClassName()
public final void save(IConfigRepository repo) throws SmaException
repo
- The configuration respository to save the descriptor to.
SmaException
- Thrown in case an error in encountered during the
saving of the object.This method saves a message view factory descriptor to a configuration repository. The descriptor is stored in a format suitable for loading subsequently using any of the load methods offered by this class.
public final void save() throws SmaException
SmaException
- Thrown in case an error in encountered during the
saving of the object.This method saves a message view factory descriptor to the default configuration repository. The descriptor is stored in a format suitable for loading subsequently using any of the load methods offered by this class.
public final void delete(IConfigRepository repo) throws SmaException
repo
- The configuration respository to delete from.
SmaException
- Thrown in case an error in encountered during the
deletion of the descriptor.This method deletes a message view factory descriptor from a configuration repository.
public final String toString()
toString
in class Object
public static boolean exists(IConfigRepository repo, String name)
repo
- The configuration respository to check in.name
- The name of the factory to check for.public static boolean exists(String name)
name
- The name of the view factory to check for.public static MessageViewFactoryDescriptor create(String name, short id, String className)
name
- The name of the factory.id
- The factory's unique identifier.className
- The name of the factory's class.public static MessageViewFactoryDescriptor load(IConfigRepository repo, String name) throws SmaException
repo
- The configuration respository to create the descriptor from.name
- The name of the factory.
SmaException
This method creates and creates a message view factory descriptor from a configuration repository.
public static MessageViewFactoryDescriptor load(String name) throws SmaException
name
- The name of the factory.
SmaException
This method creates and initializes a message view factory descriptor from the local configuration repository.
public static Map<Short,MessageViewFactoryDescriptor> loadAll(IConfigRepository repo) throws SmaException
repo
- The configuration respository to load the factories from.
This method creates and initializes message view factory descriptors for each of the providers present in the configuration repository.
SmaException
public static Map<Short,MessageViewFactoryDescriptor> loadAll() throws SmaException
This method creates and initializes message view factory descriptors for each of the factories present in the local configuration repository.
SmaException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |