org.apache.felix.scrplugin.description

Class ComponentDescription

java.lang.Object

org.apache.felix.scrplugin.description.AbstractDescription

org.apache.felix.scrplugin.description.ComponentDescription

public class ComponentDescription
extends AbstractDescription

ComponentDescription is a described component. In general all fields should be set by an annocation scanner, no default values should be assumed for these fields:

• name
• configurationPolicy

These values have the following default values:

• label : null - will be handled by the scr generator
• description : null - will be handled by the scr generator
• isAbstract : false
• isInherit : true
• createDs : true
• createPid : false (deprecated)
• createMetatype : false
• enabled : null
• immediate : null
• factory : null
• isSetMetatypeFactoryPid : false
• activate : null
• deactivate : null
• modified : null
• specVersion : null
• configuraionPid : null

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	activate Activation method.
private java.lang.String	configurationPid Configuration PID (V1.2)
private ComponentConfigurationPolicy	configurationPolicy Configuration policy.
private boolean	createDs Create ds info
private boolean	createMetatype Create metatype info.
private java.lang.String	deactivate Deactivation method.
private java.lang.String	description The description of the component.
private java.lang.Boolean	enabled Is this component enabled?
private java.lang.String	factory The factory.
private java.lang.Boolean	immediate Is this component immediately started.
private boolean	isAbstract Is this an abstract description?
private boolean	isInherit Does this inherit?
private boolean	isSetMetatypeFactoryPid The set metatype factory pid flag.
private java.lang.String	label The label of the component.
private java.lang.String	modified Modified method.
private java.lang.String	name The name of the component.
private SpecVersion	specVersion The spec version.

Fields inherited from class org.apache.felix.scrplugin.description.AbstractDescription

annotation

Constructor Summary

Constructors

Constructor and Description
ComponentDescription(ScannedAnnotation annotation)

Method Summary

Modifier and Type	Method and Description
AbstractDescription	clone()
java.lang.String	getActivate()
java.lang.String	getConfigurationPid()
ComponentConfigurationPolicy	getConfigurationPolicy()
java.lang.String	getDeactivate()
java.lang.String	getDescription()
java.lang.Boolean	getEnabled()
java.lang.String	getFactory()
java.lang.Boolean	getImmediate()
java.lang.String	getLabel()
java.lang.String	getModified()
java.lang.String	getName()
SpecVersion	getSpecVersion()
boolean	isAbstract()
boolean	isCreateDs()
boolean	isCreateMetatype()
boolean	isCreatePid() Deprecated. Do not use this anymore
boolean	isInherit()
boolean	isSetMetatypeFactoryPid()
void	setAbstract(boolean isAbstract)
void	setActivate(java.lang.String activate)
void	setConfigurationPid(java.lang.String configurationPid)
void	setConfigurationPolicy(ComponentConfigurationPolicy configurationPolicy)
void	setCreateDs(boolean createDs)
void	setCreateMetatype(boolean createMetatype)
void	setCreatePid(boolean createPid) Deprecated. Do not use this anymore
void	setDeactivate(java.lang.String deactivate)
void	setDescription(java.lang.String description)
void	setEnabled(java.lang.Boolean enabled)
void	setFactory(java.lang.String factory)
void	setImmediate(java.lang.Boolean immediate)
void	setInherit(boolean isInherit)
void	setLabel(java.lang.String label)
void	setModified(java.lang.String modified)
void	setName(java.lang.String name)
void	setSetMetatypeFactoryPid(boolean isSetMetatypeFactoryPid)
void	setSpecVersion(SpecVersion specVersion)
java.lang.String	toString()

Methods inherited from class org.apache.felix.scrplugin.description.AbstractDescription

getAnnotation, getIdentifier, getSource, setSource

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

private java.lang.String name

The name of the component.

label

private java.lang.String label

The label of the component.

description

private java.lang.String description

The description of the component.

configurationPolicy

private ComponentConfigurationPolicy configurationPolicy

Configuration policy. (V1.1)

isAbstract

private boolean isAbstract

Is this an abstract description?

isInherit

private boolean isInherit

Does this inherit?

createDs

private boolean createDs

Create ds info

createMetatype

private boolean createMetatype

Create metatype info.

enabled

private java.lang.Boolean enabled

Is this component enabled?

immediate

private java.lang.Boolean immediate

Is this component immediately started.

factory

private java.lang.String factory

The factory.

isSetMetatypeFactoryPid

private boolean isSetMetatypeFactoryPid

The set metatype factory pid flag.

activate

private java.lang.String activate

Activation method. (V1.1)

deactivate

private java.lang.String deactivate

Deactivation method. (V1.1)

modified

private java.lang.String modified

Modified method. (V1.1)

specVersion

private SpecVersion specVersion

The spec version.

configurationPid

private java.lang.String configurationPid

Configuration PID (V1.2)

Constructor Detail

ComponentDescription

public ComponentDescription(ScannedAnnotation annotation)

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getEnabled

public java.lang.Boolean getEnabled()

setEnabled

public void setEnabled(java.lang.Boolean enabled)

getImmediate

public java.lang.Boolean getImmediate()

setImmediate

public void setImmediate(java.lang.Boolean immediate)

getFactory

public java.lang.String getFactory()

setFactory

public void setFactory(java.lang.String factory)

isSetMetatypeFactoryPid

public boolean isSetMetatypeFactoryPid()

setSetMetatypeFactoryPid

public void setSetMetatypeFactoryPid(boolean isSetMetatypeFactoryPid)

isAbstract

public boolean isAbstract()

setAbstract

public void setAbstract(boolean isAbstract)

isInherit

public boolean isInherit()

setInherit

public void setInherit(boolean isInherit)

isCreateDs

public boolean isCreateDs()

setCreateDs

public void setCreateDs(boolean createDs)

isCreatePid

@Deprecated
public boolean isCreatePid()

Deprecated. Do not use this anymore

Deprecated - this will always return false as the pid property is handled by DS

Returns:

false

setCreatePid

@Deprecated
public void setCreatePid(boolean createPid)

Deprecated. Do not use this anymore

This will ignore the value provided.

Parameters:

createPid - Flag

isCreateMetatype

public boolean isCreateMetatype()

setCreateMetatype

public void setCreateMetatype(boolean createMetatype)

getConfigurationPolicy

public ComponentConfigurationPolicy getConfigurationPolicy()

setConfigurationPolicy

public void setConfigurationPolicy(ComponentConfigurationPolicy configurationPolicy)

getActivate

public java.lang.String getActivate()

setActivate

public void setActivate(java.lang.String activate)

getDeactivate

public java.lang.String getDeactivate()

setDeactivate

public void setDeactivate(java.lang.String deactivate)

getModified

public java.lang.String getModified()

setModified

public void setModified(java.lang.String modified)

getSpecVersion

public SpecVersion getSpecVersion()

setSpecVersion

public void setSpecVersion(SpecVersion specVersion)

getConfigurationPid

public java.lang.String getConfigurationPid()

setConfigurationPid

public void setConfigurationPid(java.lang.String configurationPid)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public AbstractDescription clone()

Specified by:

clone in class AbstractDescription