public interface Bus
Specifically:
Modifier and Type | Interface and Description |
---|---|
static interface |
Bus.Property
An interface describing a property for a given object
|
Modifier and Type | Field and Description |
---|---|
static String |
instanceClassNamePropertyName |
static String |
instanceDescriptionObjectName |
static String |
instanceDescriptionObjectPath |
static String |
instanceNamePropertyName |
Modifier and Type | Method and Description |
---|---|
Collection<Bus> |
getChildren()
Returns a list of all known children at this time.
|
String |
getComponentNameFor(Object component) |
Iterator |
getComponentNames()
Returns all given names of components registered with the bus.
|
String |
getDisplayName()
A terse description of this Bus instance to user interfaces.
|
UUID |
getIdentifier()
Returns a unique identifier for this Bus instance.
|
Bus |
getParent()
Returns the parent
Bus or null if no parent is set |
List<Bus.Property> |
getProperties(String pComponentName)
Returns a list of all available properties for the component with the given name
|
boolean |
isAvailable(String name)
Returns wether or not the specified component has been loaded.
|
<O> O |
lookup(String name)
returns the object defined by the given name.
|
<O> O |
lookupSafe(String name)
returns the object defined by the given name.
|
void |
setProperty(String pComponentName,
String pPropertyName,
String pPropertyValue) |
void |
writeConfiguration(Writer pWriter)
Write the configuration parameters of the Bus to the given stream as a well formed, valid XHTML unordered list.
|
void |
writeConfigurationFor(String pComponentName,
Writer pWriter)
Write the configuration parameters to the given stream as a well formed, valid XHTML unordered list.
|
static final String instanceClassNamePropertyName
static final String instanceNamePropertyName
static final String instanceDescriptionObjectName
static final String instanceDescriptionObjectPath
<O> O lookup(String name) throws BusException
If the object has been instantiated before, and that object has not yet been garbage collected, then the same instance is returned. If the object has been garbage collected, then the method acts as if the object never existed.
The method is defined to be thread-safe. It will safely allow two threads to request the same object. In any case, the two requests will return the same object even if they are running in parallel.
name
- the name of the object to be retrievedBusException
- if the object does not exist or if the name is null<O> O lookupSafe(String name)
If the object has been instantiated before, and that object has not yet been garbage collected, then the same instance is returned. If the object has been garbage collected, then the method acts as if the object never existed.
The method is defined to be thread-safe. It will safely allow two threads to request the same object. In any case, the two requests will return the same object even if they are running in parallel.
name
- the name of the object to be retrievedvoid setProperty(String pComponentName, String pPropertyName, String pPropertyValue) throws BusException
BusException
boolean isAvailable(String name)
Iterator getComponentNames()
void writeConfigurationFor(String pComponentName, Writer pWriter) throws IOException
div
and span
and pre
elements with class attributes to assist machine
parsing.pComponentName
- The name of the component to show information aboutpWriter
- The output to write the XML fragmentIOException
void writeConfiguration(Writer pWriter) throws IOException
div
and span
and pre
elements with class attributes to assist machine
parsing.pWriter
- The output to write the XML fragmentIOException
UUID getIdentifier()
String getDisplayName()
Collection<Bus> getChildren()
Bus getParent()
Bus
or null
if no parent is setBus
List<Bus.Property> getProperties(String pComponentName) throws BusException
pComponentName
- the name of the componentBusException
- if fetching the component or properties fails© 1998- 2021 Escenic AS