StandardInstrumentRegistry (intarsys runtime library)

java.lang.Object
- de.intarsys.claptz.impl.StandardInstrumentRegistry

All Implemented Interfaces:

IAttributeSupport, IStartStop, INotificationSupport
```
public class StandardInstrumentRegistry
extends Object
implements IStartStop, INotificationSupport, IAttributeSupport
```
A registry for instruments.
The instrument registry loads and controls the instruments for Stage. First all instruments are loaded in the registry. When all instruments are available, they are started. In this process all instrument object are started, thereby starting their prerequisites.

SECURITY CONSTRAINT this class may not be leaked to non platform code

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class StandardInstrumentRegistry.Facade
The public portion of the InstrumentRegistry, which itself is never leaked to client code.

Nested Classes
Modifier and Type	Class and Description
`class`	`StandardInstrumentRegistry.Facade` The public portion of the InstrumentRegistry, which itself is never leaked to client code.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_DEFAULT`
`static String`	`ACTION_FAIL`
`static String`	`ACTION_IGNORE`
`static String`	`ACTION_SKIP`
`static String`	`XE_EXTENSIONPOINT`
`static String`	`XP_EXTENSIONPOINTS`

Constructor Summary

Constructors
Constructor and Description

StandardInstrumentRegistry()

Constructors
Constructor and Description
`StandardInstrumentRegistry()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInstrumentStore(IInstrumentStore store)`
`void`	`addNotificationListener(EventType type, INotificationListener listener)` Add `listener` to the collection of objects to be informed when the receiver triggers an event of type `name`.
`IInstrument`	`createInstrument(String id, IInstrumentStore store)`
`void`	`flush()`
`Object`	`getAttribute(Object key)` Get an attribute value from the context
`ClassLoader`	`getClassLoader()`
`IInstrumentRegistry`	`getFacade()`
`List<IInstrumentStore>`	`getStores()`
`boolean`	`isReadOnly()`
`boolean`	`isStarted()` Answer `true` if this object is started
`void`	`load(IInstrumentStore store)`
`StandardExtensionPoint`	`lookupExtensionPoint(String name)`
`StandardInstrument`	`lookupInstrument(String name)`
`void`	`ppDefine(String symbolList)`
`Set<String>`	`ppGetDefines()`
`boolean`	`ppIsDefined(String symbolList)` `true` if ALL of the defines in expr are set.
`boolean`	`ppIsNotDefined(String symbolList)` `true` if NONE of the defines in expr are set.
`void`	`ppUndefine(String symbolList)`
`void`	`registerInstrument(StandardInstrument instrument)` Register a new instrument implementation along with its instrument in the registry.
`Object`	`removeAttribute(Object key)` Remove an attribute binding in the context
`void`	`removeNotificationListener(EventType type, INotificationListener listener)` Remove `listener` from the collection of objects to be informed about events of type `name`.
`Object`	`setAttribute(Object key, Object value)` Set the value of an attribute in the context
`void`	`start()` Start the component lifecycle.
`void`	`stop()` Stop the component lifecycle.
`boolean`	`stopRequested(Set visited)` Ask the component if it agrees to end its lifecycle at the very moment.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - XE_EXTENSIONPOINT
```
public static final String XE_EXTENSIONPOINT
```
    See Also:
    Constant Field Values
  - XP_EXTENSIONPOINTS
```
public static final String XP_EXTENSIONPOINTS
```
    See Also:
    Constant Field Values
  - ACTION_DEFAULT
```
public static final String ACTION_DEFAULT
```
  - ACTION_FAIL
```
public static final String ACTION_FAIL
```
    See Also:
    Constant Field Values
  - ACTION_IGNORE
```
public static final String ACTION_IGNORE
```
    See Also:
    Constant Field Values
  - ACTION_SKIP
```
public static final String ACTION_SKIP
```
    See Also:
    Constant Field Values
- Constructor Detail
  - StandardInstrumentRegistry
```
public StandardInstrumentRegistry()
```
- Method Detail
  - addInstrumentStore
```
public void addInstrumentStore(IInstrumentStore store)
```
  - addNotificationListener
```
public void addNotificationListener(EventType type,
                           INotificationListener listener)
```
    Description copied from interface: INotificationSupport
    
    Add listener to the collection of objects to be informed when the receiver triggers an event of type name.
    
    Specified by:
    
    addNotificationListener in interface INotificationSupport
    
    Parameters:
    type - The event type we are interested in.
    listener - The object to be informed about an event occurrence
  - createInstrument
```
public IInstrument createInstrument(String id,
                           IInstrumentStore store)
```
  - flush
```
public void flush()
           throws IOException
```
    Throws:
    
    IOException
  - getAttribute
```
public Object getAttribute(Object key)
```
    Description copied from interface: IAttributeSupport
    
    Get an attribute value from the context
    
    Specified by:
    
    getAttribute in interface IAttributeSupport
    
    Parameters:
    key - the name of the attribute to get
    
    Returns:
    The value of the attribute key
  - getClassLoader
```
public ClassLoader getClassLoader()
```
  - getFacade
```
public IInstrumentRegistry getFacade()
```
  - getStores
```
public List<IInstrumentStore> getStores()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: IStartStop
    
    Answer true if this object is started
    
    Specified by:
    
    isStarted in interface IStartStop
    
    Returns:
    Answer true if this object is started.
  - load
```
public void load(IInstrumentStore store)
          throws InstrumentRegistryException
```
    Throws:
    
    InstrumentRegistryException
  - lookupExtensionPoint
```
public StandardExtensionPoint lookupExtensionPoint(String name)
```
  - lookupInstrument
```
public StandardInstrument lookupInstrument(String name)
```
  - ppDefine
```
public void ppDefine(String symbolList)
```
  - ppGetDefines
```
public Set<String> ppGetDefines()
```
  - ppIsDefined
```
public boolean ppIsDefined(String symbolList)
```
    true if ALL of the defines in expr are set.
    Be especially aware that this is NOT equal to !ppIsNotDefined(expr)
    
    Parameters:
    symbolList -
    
    Returns:
  - ppIsNotDefined
```
public boolean ppIsNotDefined(String symbolList)
```
    true if NONE of the defines in expr are set.
    Be especially aware that this is NOT equal to !ppIsDefined(expr)
    
    Parameters:
    symbolList -
    
    Returns:
  - ppUndefine
```
public void ppUndefine(String symbolList)
```
  - registerInstrument
```
public void registerInstrument(StandardInstrument instrument)
                        throws InstrumentRegistryException
```
    Register a new instrument implementation along with its instrument in the registry.
    The registry will start the instrument before registration.
    
    Parameters:
    instrument -
    
    Throws:
    
    InstrumentRegistryException
  - removeAttribute
```
public Object removeAttribute(Object key)
```
    Description copied from interface: IAttributeSupport
    
    Remove an attribute binding in the context
    
    Specified by:
    
    removeAttribute in interface IAttributeSupport
    
    Parameters:
    key - the name of the attribute to remove
    
    Returns:
    The previously associated value for key
  - removeNotificationListener
```
public void removeNotificationListener(EventType type,
                              INotificationListener listener)
```
    Description copied from interface: INotificationSupport
    
    Remove listener from the collection of objects to be informed about events of type name.
    
    Specified by:
    
    removeNotificationListener in interface INotificationSupport
    
    Parameters:
    type - The event type we are no longer interested in.
    listener - The object registered for the event till now.
  - setAttribute
```
public Object setAttribute(Object key,
                  Object value)
```
    Description copied from interface: IAttributeSupport
    
    Set the value of an attribute in the context
    
    Specified by:
    
    setAttribute in interface IAttributeSupport
    
    Parameters:
    key - the name of the attribute to set
    value - the new value the attribute
    
    Returns:
    The previously associated value for key
  - start
```
public void start()
```
    Description copied from interface: IStartStop
    
    Start the component lifecycle. A RuntimeException is expected when starting the component fails.
    
    Specified by:
    
    start in interface IStartStop
  - stop
```
public void stop()
```
    Description copied from interface: IStartStop
    
    Stop the component lifecycle. All resources should be freed. A RuntimeException is expected when stopping the component fails.
    
    Specified by:
    
    stop in interface IStartStop
  - stopRequested
```
public boolean stopRequested(Set visited)
```
    Description copied from interface: IStartStop
    
    Ask the component if it agrees to end its lifecycle at the very moment. The component may deny this request, but it must be prepared anyway to be stopped.
    
    Specified by:
    
    stopRequested in interface IStartStop
    
    Parameters:
    visited - The optional set of already visited objects in the stop request cycle.

Class StandardInstrumentRegistry

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XE_EXTENSIONPOINT

XP_EXTENSIONPOINTS

ACTION_DEFAULT

ACTION_FAIL

ACTION_IGNORE

ACTION_SKIP

Constructor Detail

StandardInstrumentRegistry

Method Detail

addInstrumentStore

addNotificationListener

createInstrument

flush

getAttribute

getClassLoader

getFacade

getStores

isReadOnly

isStarted

load

lookupExtensionPoint

lookupInstrument

ppDefine

ppGetDefines

ppIsDefined

ppIsNotDefined

ppUndefine

registerInstrument

removeAttribute

removeNotificationListener

setAttribute

start

stop

stopRequested