AbstractDependency

java.lang.Object
- org.apache.felix.dm.context.AbstractDependency<T>

Type Parameters:

T - The type of the interface representing a Dependency Manager Dependency (must extends the Dependency interface).

All Implemented Interfaces:

ComponentDependencyDeclaration, DependencyContext, Dependency
```
public abstract class AbstractDependency<T extends Dependency>
extends java.lang.Object
implements Dependency, DependencyContext, ComponentDependencyDeclaration
```
Abstract class for implementing Dependencies. You can extends this class in order to supply your own custom dependencies to any Dependency Manager Component.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.util.Dictionary<java.lang.Object,java.lang.Object>`	`EMPTY_PROPERTIES` Default empty dependency properties.
`protected java.lang.String`	`m_add` Component callback used to inject an added dependency.
`protected boolean`	`m_autoConfig` Can this Dependency be auto configured in the component instance fields ?
`protected java.lang.String`	`m_autoConfigInstance` The Component field name where the Dependency can be injected (null means any field with a compatible type will be injected).
`protected boolean`	`m_autoConfigInvoked` Indicates if the setAutoConfig method has been invoked.
`protected boolean`	`m_available` Is this Dependency available ? Volatile because the getState method (part of the `ComponentDependencyDeclaration` interface) may be called by any thread, at any time.
`protected java.lang.Object`	`m_callbackInstance` The object instance on which the dependency callbacks are invoked on.
`protected java.lang.String`	`m_change` Component callback invoked when the dependency has changed.
`protected ComponentContext`	`m_component` The Component implementation is exposed to Dependencies through this interface.
`protected boolean`	`m_instanceBound` Is this Dependency "instance bound" ? A dependency is "instance bound" if it is defined within the component's init method, meaning that it won't deactivate the component if it is not currently available when being added from the component's init method.
`protected boolean`	`m_isStarted` Has this Dependency been started by the Component implementation ? Volatile because the getState method (part of the `ComponentDependencyDeclaration` interface) may be called by any thread, at any time.
`protected boolean`	`m_propagate` Tells if the dependency service properties have to be propagated to the Component service properties.
`protected java.lang.Object`	`m_propagateCallbackInstance` The propagate callback instance that is invoked in order to supply dynamically some dependency service properties.
`protected java.lang.String`	`m_propagateCallbackMethod` The propagate callback method that is invoked in order to supply dynamically some dependency service properties.
`protected boolean`	`m_propagateOverrides` Tells if the dependency service properties should override default component service properties (false by default).
`protected java.lang.String`	`m_remove` Component callback invoked when the dependency becomes unavailable.
`protected boolean`	`m_required` Is this dependency required (false by default) ?

Fields inherited from interface org.apache.felix.dm.ComponentDependencyDeclaration
STATE_AVAILABLE_OPTIONAL, STATE_AVAILABLE_REQUIRED, STATE_NAMES, STATE_OPTIONAL, STATE_REQUIRED, STATE_UNAVAILABLE_OPTIONAL, STATE_UNAVAILABLE_REQUIRED

Constructor Summary

Constructors
Constructor and Description

AbstractDependency()
Creates a new Dependency.

AbstractDependency(AbstractDependency<T> prototype)
Create a clone of a given Dependency.

Constructors
Constructor and Description
`AbstractDependency()` Creates a new Dependency.
`AbstractDependency(AbstractDependency<T> prototype)` Create a clone of a given Dependency.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyToCollection(java.util.Collection<java.lang.Object> services)` Copy all dependency service instances to the given collection.
`void`	`copyToMap(java.util.Map<java.lang.Object,java.util.Dictionary<?,?>> map)` Copy all dependency service instances to the given map (key = dependency service, value = dependency service properties.
`abstract DependencyContext`	`createCopy()` Creates a copy of this Dependency.
`protected void`	`ensureNotActive()` Checks if the component dependency is not started.
`java.lang.String`	`getAutoConfigName()` Returns the field name when the dependency can be injected to.
`abstract java.lang.Class<?>`	`getAutoConfigType()` Returns the type of the field where this dependency can be injected (auto config), or return null if autoconfig is not supported.
`ComponentContext`	`getComponentContext()` Returns the component implementation context
`protected java.lang.Object`	`getDefaultService(boolean nullObject)` Returns the default service, or null.
`java.lang.String`	`getFilter()` Returns the dependency filter, if any.
`java.lang.Object[]`	`getInstances()` Returns the dependency callback instances
`java.lang.String`	`getName()` Returns a description of this dependency (like the dependency service class name with associated filters)
`<K,V> java.util.Dictionary<K,V>`	`getProperties()` Returns the dependency service properties (empty by default).
`Event`	`getService()` Get the highest ranked available dependency service, or null.
`abstract java.lang.String`	`getSimpleName()` Returns a simple name for this dependency (like the dependency service class name).
`int`	`getState()` Returns this dependency state.
`abstract java.lang.String`	`getType()` Returns the dependency symbolic type.
`void`	`invokeCallback(EventType type, Event... events)` A Component callback must be invoked with dependency event(s).
`boolean`	`isAutoConfig()` Can this dependency be injected in a component class field (by reflexion, true by default) ?
`boolean`	`isAvailable()` Is this Dependency satisfied and available ?
`boolean`	`isInstanceBound()` Is this Dependency "instance bound" (has been defined within the component's init method) ?
`boolean`	`isPropagated()` Returns the propagate callback method that is invoked in order to supply dynamically some dependency service properties.
`boolean`	`isRequired()` Is this Dependency required (false by default) ?
`boolean`	`isStarted()` Indicates if this dependency has been started by the Component implementation.
`boolean`	`needsInstance()` Tells if the Component must be first instantiated before starting this dependency (false by default).
`boolean`	`overrideServiceProperties()` Determines if the propagated dependency properties must override the component service properties.
`T`	`setAutoConfig(boolean autoConfig)`
`T`	`setAutoConfig(java.lang.String instanceName)`
`void`	`setAvailable(boolean available)` Called by the Component implementation when the dependency is considered to be available.
`T`	`setCallbacks(java.lang.Object instance, java.lang.String add, java.lang.String remove)` Sets the callbacks for this service.
`T`	`setCallbacks(java.lang.Object instance, java.lang.String add, java.lang.String change, java.lang.String remove)` Sets the callbacks for this service.
`T`	`setCallbacks(java.lang.String add, java.lang.String remove)` Sets the add/remove callbacks.
`T`	`setCallbacks(java.lang.String add, java.lang.String change, java.lang.String remove)` Sets the add/change/remove callbacks.
`void`	`setComponentContext(ComponentContext component)` Called by the Component implementation before the Dependency can be started.
`void`	`setInstanceBound(boolean instanceBound)` Called by the Component implementation when the dependency is declared within the Component's init method.
`T`	`setPropagate(boolean propagate)` Activates Dependency service properties propagation (to the service properties of the component to which this dependency is added).
`T`	`setPropagate(boolean propagate, boolean overrideServiceProperties)`
`T`	`setPropagate(java.lang.Object instance, java.lang.String method)` Sets a callback instance which can ba invoked with the given method in order to dynamically retrieve the dependency service properties.
`T`	`setRequired(boolean required)`
`void`	`start()` Starts this dependency.
`void`	`stop()` Starts this dependency.
`java.lang.String`	`toString()`

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

- Field Detail
  - m_component
```
protected ComponentContext m_component
```
    The Component implementation is exposed to Dependencies through this interface.
  - m_available
```
protected volatile boolean m_available
```
    Is this Dependency available ? Volatile because the getState method (part of the ComponentDependencyDeclaration interface) may be called by any thread, at any time.
  - m_instanceBound
```
protected boolean m_instanceBound
```
    Is this Dependency "instance bound" ? A dependency is "instance bound" if it is defined within the component's init method, meaning that it won't deactivate the component if it is not currently available when being added from the component's init method.
  - m_required
```
protected volatile boolean m_required
```
    Is this dependency required (false by default) ?
  - m_add
```
protected volatile java.lang.String m_add
```
    Component callback used to inject an added dependency.
  - m_change
```
protected volatile java.lang.String m_change
```
    Component callback invoked when the dependency has changed.
  - m_remove
```
protected volatile java.lang.String m_remove
```
    Component callback invoked when the dependency becomes unavailable.
  - m_autoConfig
```
protected volatile boolean m_autoConfig
```
    Can this Dependency be auto configured in the component instance fields ?
  - m_autoConfigInstance
```
protected volatile java.lang.String m_autoConfigInstance
```
    The Component field name where the Dependency can be injected (null means any field with a compatible type will be injected).
  - m_autoConfigInvoked
```
protected volatile boolean m_autoConfigInvoked
```
    Indicates if the setAutoConfig method has been invoked. This flag is used to force autoconfig to "false" when the setCallbacks method is invoked, unless the setAutoConfig method has been called.
  - m_isStarted
```
protected volatile boolean m_isStarted
```
    Has this Dependency been started by the Component implementation ? Volatile because the getState method (part of the ComponentDependencyDeclaration interface) may be called by any thread, at any time.
  - m_callbackInstance
```
protected volatile java.lang.Object m_callbackInstance
```
    The object instance on which the dependency callbacks are invoked on. Null means the dependency will be injected to the Component implementation instance(s).
  - m_propagate
```
protected volatile boolean m_propagate
```
    Tells if the dependency service properties have to be propagated to the Component service properties.
  - m_propagateOverrides
```
protected volatile boolean m_propagateOverrides
```
    Tells if the dependency service properties should override default component service properties (false by default).
  - m_propagateCallbackInstance
```
protected volatile java.lang.Object m_propagateCallbackInstance
```
    The propagate callback instance that is invoked in order to supply dynamically some dependency service properties.
  - m_propagateCallbackMethod
```
protected volatile java.lang.String m_propagateCallbackMethod
```
    The propagate callback method that is invoked in order to supply dynamically some dependency service properties.
    
    See Also:
    
    #m_propagateCallbackInstance}
  - EMPTY_PROPERTIES
```
protected static final java.util.Dictionary<java.lang.Object,java.lang.Object> EMPTY_PROPERTIES
```
    Default empty dependency properties.
- Constructor Detail
  - AbstractDependency
```
public AbstractDependency()
```
    Creates a new Dependency. By default, the dependency is optional and autoconfig.
  - AbstractDependency
```
public AbstractDependency(AbstractDependency<T> prototype)
```
    Create a clone of a given Dependency.
    
    Parameters:
    
    prototype - all the fields of the prototype will be copied to this dependency.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isRequired
```
public boolean isRequired()
```
    Is this Dependency required (false by default) ?
    
    Specified by:
    
    isRequired in interface Dependency
    
    Returns:
    
    true if the dependency is required
  - isAvailable
```
public boolean isAvailable()
```
    Is this Dependency satisfied and available ?
    
    Specified by:
    
    isAvailable in interface Dependency
    
    Returns:
    
    true if the dependency is available
  - isAutoConfig
```
public boolean isAutoConfig()
```
    Can this dependency be injected in a component class field (by reflexion, true by default) ?
    
    Specified by:
    
    isAutoConfig in interface Dependency
    
    Returns:
    
    true if auto configuration is enabled for this dependency
  - getAutoConfigName
```
public java.lang.String getAutoConfigName()
```
    Returns the field name when the dependency can be injected to.
    
    Specified by:
    
    getAutoConfigName in interface Dependency
    
    Returns:
    
    the name of the member in the class of the component instance to inject into
  - isPropagated
```
public boolean isPropagated()
```
    Returns the propagate callback method that is invoked in order to supply dynamically some dependency service properties.
    
    Specified by:
    
    isPropagated in interface Dependency
    
    Returns:
    
    true if the properties should be propagated
    
    See Also:
    
    #m_propagateCallbackInstance}
  - overrideServiceProperties
```
public boolean overrideServiceProperties()
```
    Description copied from interface: Dependency
    
    Determines if the propagated dependency properties must override the component service properties. By default, propagated service properties don't override the component service properties. It means that a given dependency property does not override the same property in the component service properties.
    
    Specified by:
    
    overrideServiceProperties in interface Dependency
    
    Returns:
    
    true if the dependency service properties are propagated and override the component service properties.
  - getProperties
```
public <K,V> java.util.Dictionary<K,V> getProperties()
```
    Returns the dependency service properties (empty by default).
    
    Specified by:
    
    getProperties in interface Dependency
    
    Returns:
    
    the properties
    
    See Also:
    
    Dependency.isPropagated()
  - setComponentContext
```
public void setComponentContext(ComponentContext component)
```
    Called by the Component implementation before the Dependency can be started.
    
    Specified by:
    
    setComponentContext in interface DependencyContext
    
    Parameters:
    
    component - the Component implementation context
  - invokeCallback
```
public void invokeCallback(EventType type,
                           Event... events)
```
    A Component callback must be invoked with dependency event(s).
    
    Specified by:
    
    invokeCallback in interface DependencyContext
    
    Parameters:
    
    type - the dependency event type
    
    events - the dependency service event to inject in the component. The number of events depends on the dependency event type: ADDED/CHANGED/REMOVED types only has one event parameter, but the SWAPPED type has two event parameters: the first one is the old event which must be replaced by the second one.
    
    See Also:
    
    ComponentContext.handleEvent(DependencyContext, EventType, Event...), EventType
  - start
```
public void start()
```
    Starts this dependency. Subclasses can override this method but must then call super.start().
    
    Specified by:
    
    start in interface DependencyContext
  - stop
```
public void stop()
```
    Starts this dependency. Subclasses can override this method but must then call super.stop().
    
    Specified by:
    
    stop in interface DependencyContext
  - isStarted
```
public boolean isStarted()
```
    Indicates if this dependency has been started by the Component implementation.
    
    Specified by:
    
    isStarted in interface DependencyContext
    
    Returns:
    
    true if the dependency has been started, false if not
  - setAvailable
```
public void setAvailable(boolean available)
```
    Called by the Component implementation when the dependency is considered to be available.
    
    Specified by:
    
    setAvailable in interface DependencyContext
    
    Parameters:
    
    available - true to mark this dependency as available, false to mark it as unavailable
  - isInstanceBound
```
public boolean isInstanceBound()
```
    Is this Dependency "instance bound" (has been defined within the component's init method) ?
    
    Specified by:
    
    isInstanceBound in interface DependencyContext
    
    Returns:
    
    true if this dependency is instance bound, false if not
  - setInstanceBound
```
public void setInstanceBound(boolean instanceBound)
```
    Called by the Component implementation when the dependency is declared within the Component's init method.
    
    Specified by:
    
    setInstanceBound in interface DependencyContext
  - needsInstance
```
public boolean needsInstance()
```
    Tells if the Component must be first instantiated before starting this dependency (false by default).
    
    Specified by:
    
    needsInstance in interface DependencyContext
    
    Returns:
    
    true if the dependency need the component instances before it can be started, false if not.
  - getAutoConfigType
```
public abstract java.lang.Class<?> getAutoConfigType()
```
    Returns the type of the field where this dependency can be injected (auto config), or return null if autoconfig is not supported.
    
    Specified by:
    
    getAutoConfigType in interface DependencyContext
    
    Returns:
    
    the type of the field which can be injected with the dependency service, or null if the dependency does not support auto config mode.
  - getService
```
public Event getService()
```
    Get the highest ranked available dependency service, or null.
    
    Specified by:
    
    getService in interface DependencyContext
    
    Returns:
    
    the highest ranked available dependency service instance, or null
  - copyToCollection
```
public void copyToCollection(java.util.Collection<java.lang.Object> services)
```
    Copy all dependency service instances to the given collection.
    
    Specified by:
    
    copyToCollection in interface DependencyContext
    
    Parameters:
    
    services - the collection where the dependency service instances will be copied
  - copyToMap
```
public void copyToMap(java.util.Map<java.lang.Object,java.util.Dictionary<?,?>> map)
```
    Copy all dependency service instances to the given map (key = dependency service, value = dependency service properties.
    
    Specified by:
    
    copyToMap in interface DependencyContext
    
    Parameters:
    
    map - the map where the dependency service instances (with the corresponding service properties)
  - createCopy
```
public abstract DependencyContext createCopy()
```
    Creates a copy of this Dependency.
    
    Specified by:
    
    createCopy in interface DependencyContext
    
    Returns:
    
    a clone of this dependency.
  - getName
```
public java.lang.String getName()
```
    Returns a description of this dependency (like the dependency service class name with associated filters)
    
    Specified by:
    
    getName in interface ComponentDependencyDeclaration
  - getSimpleName
```
public abstract java.lang.String getSimpleName()
```
    Returns a simple name for this dependency (like the dependency service class name).
    
    Specified by:
    
    getSimpleName in interface ComponentDependencyDeclaration
  - getType
```
public abstract java.lang.String getType()
```
    Returns the dependency symbolic type.
    
    Specified by:
    
    getType in interface ComponentDependencyDeclaration
  - getFilter
```
public java.lang.String getFilter()
```
    Returns the dependency filter, if any.
    
    Specified by:
    
    getFilter in interface ComponentDependencyDeclaration
  - getState
```
public int getState()
```
    Returns this dependency state.
    
    Specified by:
    
    getState in interface ComponentDependencyDeclaration
  - setPropagate
```
public T setPropagate(boolean propagate)
```
    Activates Dependency service properties propagation (to the service properties of the component to which this dependency is added).
    
    Parameters:
    
    propagate - true if the dependency service properties must be propagated to the service properties of the component to which this dependency is added.
    
    Returns:
    
    this dependency instance
  - setPropagate
```
public T setPropagate(boolean propagate,
                      boolean overrideServiceProperties)
```
  - setPropagate
```
public T setPropagate(java.lang.Object instance,
                      java.lang.String method)
```
    Sets a callback instance which can ba invoked with the given method in order to dynamically retrieve the dependency service properties.
    
    Parameters:
    
    instance - the callback instance
    
    method - the method to invoke on the callback instance
    
    Returns:
    
    this dependency instance
  - setCallbacks
```
public T setCallbacks(java.lang.String add,
                      java.lang.String remove)
```
    Sets the add/remove callbacks.
    
    Parameters:
    
    add - the callback to invoke when a dependency is added
    
    remove - the callback to invoke when a dependency is removed
    
    Returns:
    
    this dependency instance
  - setCallbacks
```
public T setCallbacks(java.lang.String add,
                      java.lang.String change,
                      java.lang.String remove)
```
    Sets the add/change/remove callbacks.
    
    Parameters:
    
    add - the callback to invoke when a dependency is added
    
    change - the callback to invoke when a dependency has changed
    
    remove - the callback to invoke when a dependency is removed
    
    Returns:
    
    this dependency instance
  - setCallbacks
```
public T setCallbacks(java.lang.Object instance,
                      java.lang.String add,
                      java.lang.String remove)
```
    Sets the callbacks for this service. These callbacks can be used as hooks whenever a dependency is added or removed. They are called on the instance you provide. When you specify callbacks, the auto configuration feature is automatically turned off, because we're assuming you don't need it in this case.
    
    Parameters:
    
    instance - the instance to call the callbacks on
    
    add - the method to call when a service was added
    
    remove - the method to call when a service was removed
    
    Returns:
    
    this service dependency
  - setCallbacks
```
public T setCallbacks(java.lang.Object instance,
                      java.lang.String add,
                      java.lang.String change,
                      java.lang.String remove)
```
    Sets the callbacks for this service. These callbacks can be used as hooks whenever a dependency is added, changed or removed. They are called on the instance you provide. When you specify callbacks, the auto configuration feature is automatically turned off, because we're assuming you don't need it in this case.
    
    Parameters:
    
    instance - the instance to call the callbacks on
    
    add - the method to call when a service was added
    
    change - the method to call when a service was changed
    
    remove - the method to call when a service was removed
    
    Returns:
    
    this service dependency
  - getInstances
```
public java.lang.Object[] getInstances()
```
    Returns the dependency callback instances
    
    Returns:
    
    the dependency callback instances
  - setRequired
```
public T setRequired(boolean required)
```
    See Also:
    
    ServiceDependency#setRequired(boolean)}
  - setAutoConfig
```
public T setAutoConfig(boolean autoConfig)
```
    See Also:
    
    ServiceDependency#setAutoConfig(boolean)}
  - setAutoConfig
```
public T setAutoConfig(java.lang.String instanceName)
```
    See Also:
    
    ServiceDependency#setAutoConfig(String instanceName)}
  - getComponentContext
```
public ComponentContext getComponentContext()
```
    Returns the component implementation context
    
    Specified by:
    
    getComponentContext in interface DependencyContext
    
    Returns:
    
    the component implementation context
  - getDefaultService
```
protected java.lang.Object getDefaultService(boolean nullObject)
```
    Returns the default service, or null.
    
    Parameters:
    
    nullObject - if true, a null object may be returned.
    
    Returns:
    
    the default service
  - ensureNotActive
```
protected void ensureNotActive()
```
    Checks if the component dependency is not started.

Class AbstractDependency<T extends Dependency>

Field Summary

Fields inherited from interface org.apache.felix.dm.ComponentDependencyDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_component

m_available

m_instanceBound

m_required

m_add

m_change

m_remove

m_autoConfig

m_autoConfigInstance

m_autoConfigInvoked

m_isStarted

m_callbackInstance

m_propagate

m_propagateOverrides

m_propagateCallbackInstance

m_propagateCallbackMethod

EMPTY_PROPERTIES

Constructor Detail

AbstractDependency

AbstractDependency

Method Detail

toString

isRequired

isAvailable

isAutoConfig

getAutoConfigName

isPropagated

overrideServiceProperties

getProperties

setComponentContext

invokeCallback

start

stop

isStarted

setAvailable

isInstanceBound

setInstanceBound

needsInstance

getAutoConfigType

getService

copyToCollection

copyToMap

createCopy

getName

getSimpleName

getType

getFilter

getState

setPropagate

setPropagate

setPropagate

setCallbacks

setCallbacks

setCallbacks

setCallbacks

getInstances

setRequired

setAutoConfig

setAutoConfig

getComponentContext

getDefaultService

ensureNotActive