org.apache.felix.scrplugin.om
Class Component

java.lang.Object
  extended by org.apache.felix.scrplugin.om.AbstractObject
      extended by org.apache.felix.scrplugin.om.Component

public class Component
extends AbstractObject

Component is a described component.


Field Summary
protected  java.lang.Boolean enabled
          Is this component enabled?
protected  java.lang.String factory
          The factory.
protected  java.lang.Boolean immediate
          Is this component immediately started.
protected  Implementation implementation
          The implementation.
protected  boolean isAbstract
          Is this an abstract description?
protected  boolean isDs
          Is this a descriptor to be ignored ?
protected  java.lang.String name
          The name of the component.
protected  java.util.List properties
          All properties.
protected  java.util.List references
          The references.
protected  Service service
          The corresponding service.
 
Fields inherited from class org.apache.felix.scrplugin.om.AbstractObject
tag
 
Constructor Summary
Component()
          Default constructor.
Component(JavaTag t)
          Constructor from java source.
 
Method Summary
 void addProperty(Property property)
           
 void addReference(Reference ref)
           
protected  void checkLifecycleMethod(JavaClassDescription javaClass, java.lang.String methodName, java.util.List warnings)
          Check for existence of lifecycle methods.
 java.lang.String getFactory()
           
 Implementation getImplementation()
           
 JavaClassDescription getJavaClassDescription()
          Return the associated java class description
 java.lang.String getName()
           
 java.util.List getProperties()
           
 java.util.List getReferences()
           
 Service getService()
           
 boolean isAbstract()
           
 boolean isDs()
           
 java.lang.Boolean isEnabled()
           
 java.lang.Boolean isImmediate()
           
 void setAbstract(boolean isAbstract)
           
 void setDs(boolean isDs)
           
 void setEnabled(java.lang.Boolean enabled)
           
 void setFactory(java.lang.String factory)
           
 void setImmediate(java.lang.Boolean immediate)
           
 void setImplementation(Implementation implementation)
           
 void setName(java.lang.String name)
           
 void setProperties(java.util.List properties)
           
 void setReferences(java.util.List references)
           
 void setService(Service service)
           
 void validate(java.util.List issues, java.util.List warnings)
          Validate the component description.
 
Methods inherited from class org.apache.felix.scrplugin.om.AbstractObject
getMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name
The name of the component.


enabled

protected java.lang.Boolean enabled
Is this component enabled?


immediate

protected java.lang.Boolean immediate
Is this component immediately started.


factory

protected java.lang.String factory
The factory.


implementation

protected Implementation implementation
The implementation.


properties

protected java.util.List properties
All properties.


service

protected Service service
The corresponding service.


references

protected java.util.List references
The references.


isAbstract

protected boolean isAbstract
Is this an abstract description?


isDs

protected boolean isDs
Is this a descriptor to be ignored ?

Constructor Detail

Component

public Component()
Default constructor.


Component

public Component(JavaTag t)
Constructor from java source.

Method Detail

getJavaClassDescription

public JavaClassDescription getJavaClassDescription()
Return the associated java class description


getProperties

public java.util.List getProperties()
Returns:
All properties of this component.

setProperties

public void setProperties(java.util.List properties)

addProperty

public void addProperty(Property property)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getFactory

public java.lang.String getFactory()

setFactory

public void setFactory(java.lang.String factory)

isEnabled

public java.lang.Boolean isEnabled()

setEnabled

public void setEnabled(java.lang.Boolean enabled)

isImmediate

public java.lang.Boolean isImmediate()

setImmediate

public void setImmediate(java.lang.Boolean immediate)

getImplementation

public Implementation getImplementation()

setImplementation

public void setImplementation(Implementation implementation)

getService

public Service getService()

setService

public void setService(Service service)

getReferences

public java.util.List getReferences()

setReferences

public void setReferences(java.util.List references)

addReference

public void addReference(Reference ref)

isAbstract

public boolean isAbstract()

setAbstract

public void setAbstract(boolean isAbstract)

isDs

public boolean isDs()

setDs

public void setDs(boolean isDs)

validate

public void validate(java.util.List issues,
                     java.util.List warnings)
              throws org.apache.maven.plugin.MojoExecutionException
Validate the component description. If errors occur a message is added to the issues list, warnings can be added to the warnings list.

Throws:
org.apache.maven.plugin.MojoExecutionException

checkLifecycleMethod

protected void checkLifecycleMethod(JavaClassDescription javaClass,
                                    java.lang.String methodName,
                                    java.util.List warnings)
                             throws org.apache.maven.plugin.MojoExecutionException
Check for existence of lifecycle methods.

Parameters:
javaClass - The java class to inspect.
methodName - The method name.
warnings - The list of warnings used to add new warnings.
Throws:
org.apache.maven.plugin.MojoExecutionException