Component instantiation description.
addRequirement
public void addRequirement(ComponentRequirement requirement)
Add a project requirement to this component.
requirement
- the requirement to add
addRequirements
public void addRequirements(List requirements)
Adds a list of requirements to this component.
requirements
- the requirements to add
equals
public boolean equals(Object other)
getAlias
public String getAlias()
Returns an alias for this component. An alias as an
alternate name other than the normal key.
- an alias for this component
getComponentComposer
public String getComponentComposer()
Returns the ID of the type of composer this component will use. For example,
"setter" or "field" for the different types of dependency injection.
- the ID of the type of composer this component will use
getComponentConfigurator
public String getComponentConfigurator()
Returns the type of component configurator for this project. For
example "basic" for normal, or "map-oriented" for map oriented
components.
- the type of component configurator for this project
getComponentFactory
public String getComponentFactory()
Returns an id of the factory used to create this component.
- an id of the factory used to create this component
getComponentProfile
public String getComponentProfile()
getComponentSetDescriptor
public ComponentSetDescriptor getComponentSetDescriptor()
Returns the component set descriptor.
- the component set descriptor
getComponentType
public String getComponentType()
Returns the type of this component.
- the type of this component
getConfiguration
public PlexusConfiguration getConfiguration()
Returns configuration values defined for this component.
- configuration values defined for this component
getDependencies
public List getDependencies()
Returns a List of dependencies of this component.
- a List of dependencies of this component
getDescription
public String getDescription()
Return a human-readable description of this component.
- a human-readable description of this component
getHumanReadableKey
public String getHumanReadableKey()
Returns a human-friendly key, suitable for display.
getImplementation
public String getImplementation()
Returns the implementation of this componet. Implementation
is a string denoting a FQCN in normal Java components, or
some other name or file for other component factory implementations.
- the implementation of this componet's role.
getInstantiationStrategy
public String getInstantiationStrategy()
Returns the type of instantiation strategy for this component.
- the type of instantiation strategy for this component
getLifecycleHandler
public String getLifecycleHandler()
Returns the lifecycle-handler for this component.
- the lifecycle-handler for this component
getRealmId
public String getRealmId()
The ClassRealm that this component lives under.
- ClassRealm that this component lives under
getRequirements
public List getRequirements()
Returns all project requirements of this component.
- all project requirements of this component
getRole
public String getRole()
Returns the role of this component.
- the role of this component
getRoleHint
public String getRoleHint()
Returns the role-hint of this component.
- the role-hint of this component
getVersion
public String getVersion()
Returns a specific point in a components's project timeline.
i.e. version 1, or 2.1.4
- a specific point in a components's project timeline
hasConfiguration
public boolean hasConfiguration()
Returns true if this component has a configuration.
- true if this component has a configuration
hashCode
public int hashCode()
isIsolatedRealm
public boolean isIsolatedRealm()
Returns true if this may be in an isolated classrealm.
- true if this may be in an isolated classrealm
setAlias
public void setAlias(String alias)
Sets the alias for this component.
alias
- alternate name to set
setComponentComposer
public void setComponentComposer(String componentComposer)
Sets a representation of the composer this component uses.
componentComposer
- string representation of the composer to use
setComponentConfigurator
public void setComponentConfigurator(String componentConfigurator)
Sets the type of component configurator for this project.
setComponentFactory
public void setComponentFactory(String componentFactory)
Sets the id of the factory to use to create this component. For
example, "jruby" will use a JRuby factory.
setComponentProfile
public void setComponentProfile(String componentProfile)
setComponentSetDescriptor
public void setComponentSetDescriptor(ComponentSetDescriptor componentSetDescriptor)
Sets the component set descriptor of components and dependencies for
this component.
componentSetDescriptor
- the component set descriptor of components
and dependencies
setComponentType
public void setComponentType(String componentType)
Sets this component's type.
componentType
- the type to set
setConfiguration
public void setConfiguration(PlexusConfiguration configuration)
Sets the configuration hierarchy for this component.
configuration
- the configuration hierarchy to set
setDescription
public void setDescription(String description)
Sets a description of this component for users to read.
description
- a human-readable description of this component
setImplementation
public void setImplementation(String implementation)
Sets the implementation of this componet.
implementation
- string denoting a FQCN in normal Java components,
or some other name or file for other component factory implementations
setInstantiationStrategy
public void setInstantiationStrategy(String instantiationStrategy)
Sets the instantiation-strategy for this component. For example,
"container".
setIsolatedRealm
public void setIsolatedRealm(boolean isolatedRealm)
Sets that this component may be in an isolated classrealm.
isolatedRealm
- true if this component may be in an isolated
classrealm
setLifecycleHandler
public void setLifecycleHandler(String lifecycleHandler)
Sets the lifecycle-handler for this component. For example,
"basic", "passive", "bootstrap".
lifecycleHandler
- the lifecycle handler string to set
setRealmId
public void setRealmId(String realmId)
Set the id of the ClassRealm that this component lives under.
setRole
public void setRole(String role)
Sets the role of this component.
role
- this component's role
setRoleHint
public void setRoleHint(String roleHint)
Sets the role-hint of this component.
Pasing null will set the hint to the default value.
roleHint
- this component's role-hint
setVersion
public void setVersion(String version)
Sets the point in a components's project development timeline
version
- the components's version
toString
public String toString()