org.codehaus.plexus.component.repository
public class ComponentDescriptor extends Object
Version: $Id: ComponentDescriptor.java 6965 2007-10-21 05:32:27Z jvanzyl $
Field Summary | |
---|---|
String | alias |
String | componentComposer |
String | componentConfigurator |
String | componentFactory |
String | componentProfile |
ComponentSetDescriptor | componentSetDescriptor |
String | componentType |
PlexusConfiguration | configuration |
List | dependencies |
String | description |
String | implementation |
String | instantiationStrategy |
boolean | isolatedRealm |
String | lifecycleHandler |
String | realmId |
List | requirements |
String | role |
String | roleHint |
String | source |
String | version |
Method Summary | |
---|---|
void | addRequirement(ComponentRequirement requirement)
Add a project requirement to this component.
|
void | addRequirements(List requirements)
Adds a list of requirements to this component.
|
boolean | equals(Object other) |
String | getAlias()
Returns an alias for this component. |
String | getComponentComposer()
Returns the ID of the type of composer this component will use. |
String | getComponentConfigurator()
Returns the type of component configurator for this project. |
String | getComponentFactory()
Returns an id of the factory used to create this component.
|
String | getComponentProfile() |
ComponentSetDescriptor | getComponentSetDescriptor()
Returns the component set descriptor.
|
String | getComponentType()
Returns the type of this component.
|
PlexusConfiguration | getConfiguration()
Returns configuration values defined for this component.
|
List | getDependencies()
Returns a List of dependencies of this component.
|
String | getDescription()
Return a human-readable description of this component.
|
String | getHumanReadableKey()
Returns a human-friendly key, suitable for display.
|
String | getImplementation()
Returns the implementation of this componet. |
String | getInstantiationStrategy()
Returns the type of instantiation strategy for this component.
|
String | getLifecycleHandler()
Returns the lifecycle-handler for this component.
|
String | getRealmId()
The ClassRealm that this component lives under.
|
List | getRequirements()
Returns all project requirements of this component.
|
String | getRole()
Returns the role of this component.
|
String | getRoleHint()
Returns the role-hint of this component.
|
String | getSource()
The location this information came from (descriptor file URI). |
String | getVersion()
Returns a specific point in a components's project timeline. i.e. version 1, or 2.1.4
|
boolean | hasConfiguration()
Returns true if this component has a configuration.
|
int | hashCode() |
boolean | isIsolatedRealm()
Returns true if this may be in an isolated classrealm.
|
void | setAlias(String alias)
Sets the alias for this component.
|
void | setComponentComposer(String componentComposer)
Sets a representation of the composer this component uses.
|
void | setComponentConfigurator(String componentConfigurator)
Sets the type of component configurator for this project.
|
void | setComponentFactory(String componentFactory)
Sets the id of the factory to use to create this component. |
void | setComponentProfile(String componentProfile) |
void | setComponentSetDescriptor(ComponentSetDescriptor componentSetDescriptor)
Sets the component set descriptor of components and dependencies for this component.
|
void | setComponentType(String componentType)
Sets this component's type.
|
void | setConfiguration(PlexusConfiguration configuration)
Sets the configuration hierarchy for this component.
|
void | setDescription(String description)
Sets a description of this component for users to read.
|
void | setImplementation(String implementation)
Sets the implementation of this componet.
|
void | setInstantiationStrategy(String instantiationStrategy)
Sets the instantiation-strategy for this component. |
void | setIsolatedRealm(boolean isolatedRealm)
Sets that this component may be in an isolated classrealm.
|
void | setLifecycleHandler(String lifecycleHandler)
Sets the lifecycle-handler for this component. |
void | setRealmId(String realmId)
Set the id of the ClassRealm that this component lives under.
|
void | setRole(String role)
Sets the role of this component.
|
void | setRoleHint(String roleHint)
Sets the role-hint of this component. |
void | setSource(String source)
The location this information came from (descriptor file URI). |
void | setVersion(String version)
Sets the point in a components's project development timeline
|
String | toString() |
Parameters: requirement the requirement to add
Parameters: requirements the requirements to add
Returns: an alias for this component
Returns: the ID of the type of composer this component will use
Returns: the type of component configurator for this project
Returns: an id of the factory used to create this component
Returns: the component set descriptor
Returns: the type of this component
Returns: configuration values defined for this component
Returns: a List of dependencies of this component
Returns: a human-readable description of this component
Returns: a human-friendly key
Returns: the implementation of this componet's role.
Returns: the type of instantiation strategy for this component
Returns: the lifecycle-handler for this component
Returns: ClassRealm that this component lives under
Returns: all project requirements of this component
Returns: the role of this component
Returns: the role-hint of this component
Returns: a specific point in a components's project timeline
Returns: true if this component has a configuration
Returns: true if this may be in an isolated classrealm
Parameters: alias alternate name to set
Parameters: componentComposer string representation of the composer to use
Parameters: componentConfigurator
Parameters: componentFactory
Parameters: componentSetDescriptor the component set descriptor of components and dependencies
Parameters: componentType the type to set
Parameters: configuration the configuration hierarchy to set
Parameters: description a human-readable description of this component
Parameters: implementation string denoting a FQCN in normal Java components, or some other name or file for other component factory implementations
Parameters: instantiationStrategy
Parameters: isolatedRealm true if this component may be in an isolated classrealm
Parameters: lifecycleHandler the lifecycle handler string to set
Parameters: realmId ClassRealm id
Parameters: role this component's role
Parameters: roleHint this component's role-hint
Parameters: version the components's version