public class ComponentDescriptor<T>
extends java.lang.Object
Constructor | Description |
---|---|
ComponentDescriptor() |
|
ComponentDescriptor(java.lang.Class<T> implementationClass,
org.codehaus.plexus.classworlds.realm.ClassRealm realm) |
Modifier and Type | Method | Description |
---|---|---|
void |
addRequirement(ComponentRequirement requirement) |
Add a project requirement to this component.
|
void |
addRequirement(ComponentRequirement... requirement) |
Add a project requirement to this component.
|
void |
addRequirements(java.util.List<ComponentRequirement> requirements) |
Adds a list of requirements to this component.
|
boolean |
equals(java.lang.Object other) |
|
java.lang.String |
getAlias() |
Returns an alias for this component.
|
java.lang.String |
getComponentComposer() |
Returns the ID of the type of composer this component will use.
|
java.lang.String |
getComponentConfigurator() |
Returns the type of component configurator for this project.
|
java.lang.String |
getComponentFactory() |
Returns an id of the factory used to create this component.
|
java.lang.String |
getComponentProfile() |
|
ComponentSetDescriptor |
getComponentSetDescriptor() |
Returns the component set descriptor.
|
java.lang.String |
getComponentType() |
Returns the type of this component.
|
org.codehaus.plexus.configuration.PlexusConfiguration |
getConfiguration() |
Returns configuration values defined for this component.
|
java.lang.String |
getDescription() |
Return a human-readable description of this component.
|
java.lang.String |
getHumanReadableKey() |
Returns a human-friendly key, suitable for display.
|
java.lang.String |
getImplementation() |
Returns the implementation of this componet.
|
java.lang.Class<? extends T> |
getImplementationClass() |
Returns the implementation class of this componet, or null if the implementation class can not be loaded.
|
java.lang.String |
getInstantiationStrategy() |
Returns the type of instantiation strategy for this component.
|
java.lang.String |
getLifecycleHandler() |
Returns the lifecycle-handler for this component.
|
org.codehaus.plexus.classworlds.realm.ClassRealm |
getRealm() |
The ClassRealm that this component lives under.
|
java.util.List<ComponentRequirement> |
getRequirements() |
Returns all project requirements of this component.
|
java.lang.String |
getRole() |
Returns the role of this component.
|
java.lang.Class<? extends T> |
getRoleClass() |
|
java.lang.String |
getRoleHint() |
Returns the role-hint of this component.
|
java.lang.String |
getSource() |
The location this information came from (descriptor file URI).
|
java.lang.String |
getVersion() |
Returns a specific point in a components's project timeline.
|
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 |
removeRequirement(ComponentRequirement... requirement) |
Remove a project requirement from this component.
|
void |
removeRequirements(java.util.List<ComponentRequirement> requirements) |
Removes a list of requirements from this component.
|
void |
setAlias(java.lang.String alias) |
Sets the alias for this component.
|
void |
setComponentComposer(java.lang.String componentComposer) |
Sets a representation of the composer this component uses.
|
void |
setComponentConfigurator(java.lang.String componentConfigurator) |
Sets the type of component configurator for this project.
|
void |
setComponentFactory(java.lang.String componentFactory) |
Sets the id of the factory to use to create this component.
|
void |
setComponentProfile(java.lang.String componentProfile) |
|
void |
setComponentSetDescriptor(ComponentSetDescriptor componentSetDescriptor) |
Sets the component set descriptor of components and dependencies for this component.
|
void |
setComponentType(java.lang.String componentType) |
Sets this component's type.
|
void |
setConfiguration(org.codehaus.plexus.configuration.PlexusConfiguration configuration) |
Sets the configuration hierarchy for this component.
|
void |
setDescription(java.lang.String description) |
Sets a description of this component for users to read.
|
void |
setImplementation(java.lang.String implementation) |
Sets the implementation of this componet.
|
void |
setImplementationClass(java.lang.Class<? extends T> implementationClass) |
|
void |
setInstantiationStrategy(java.lang.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(java.lang.String lifecycleHandler) |
Sets the lifecycle-handler for this component.
|
void |
setRealm(org.codehaus.plexus.classworlds.realm.ClassRealm realm) |
Set the ClassRealm that this component lives under.
|
void |
setRole(java.lang.String role) |
Sets the role of this component.
|
void |
setRoleClass(java.lang.Class<? extends T> roleClass) |
|
void |
setRoleHint(java.lang.String roleHint) |
Sets the role-hint of this component.
|
void |
setSource(java.lang.String source) |
The location this information came from (descriptor file URI).
|
void |
setVersion(java.lang.String version) |
Sets the point in a components's project development timeline
|
java.lang.String |
toString() |
public ComponentDescriptor()
public ComponentDescriptor(java.lang.Class<T> implementationClass, org.codehaus.plexus.classworlds.realm.ClassRealm realm)
public void setSource(java.lang.String source)
source
- Set the source
.public java.lang.String getSource()
source
public java.lang.String getHumanReadableKey()
public java.lang.String getAlias()
public void setAlias(java.lang.String alias)
alias
- alternate name to setpublic java.lang.String getRole()
public java.lang.Class<? extends T> getRoleClass()
public void setRole(java.lang.String role)
role
- this component's rolepublic void setRoleClass(java.lang.Class<? extends T> roleClass)
public java.lang.String getRoleHint()
public void setRoleHint(java.lang.String roleHint)
roleHint
- this component's role-hintpublic java.lang.String getImplementation()
public void setImplementation(java.lang.String implementation)
implementation
- string denoting a FQCN in normal Java components, or some other name or file for other
component factory implementationspublic java.lang.Class<? extends T> getImplementationClass()
public void setImplementationClass(java.lang.Class<? extends T> implementationClass)
public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- the components's versionpublic java.lang.String getComponentType()
public void setComponentType(java.lang.String componentType)
componentType
- the type to setpublic java.lang.String getInstantiationStrategy()
public org.codehaus.plexus.configuration.PlexusConfiguration getConfiguration()
public void setConfiguration(org.codehaus.plexus.configuration.PlexusConfiguration configuration)
configuration
- the configuration hierarchy to setpublic boolean hasConfiguration()
public java.lang.String getLifecycleHandler()
public void setLifecycleHandler(java.lang.String lifecycleHandler)
lifecycleHandler
- the lifecycle handler string to setpublic java.lang.String getComponentProfile()
public void setComponentProfile(java.lang.String componentProfile)
public void addRequirement(ComponentRequirement requirement)
requirement
- the requirement to addpublic void addRequirement(ComponentRequirement... requirement)
requirement
- the requirement to addpublic void addRequirements(java.util.List<ComponentRequirement> requirements)
requirements
- the requirements to addpublic void removeRequirement(ComponentRequirement... requirement)
requirement
- the requirement to removepublic void removeRequirements(java.util.List<ComponentRequirement> requirements)
requirements
- the requirements to removepublic java.util.List<ComponentRequirement> getRequirements()
public java.lang.String getComponentFactory()
public void setComponentFactory(java.lang.String componentFactory)
componentFactory
- The component factory.public java.lang.String getComponentComposer()
public void setComponentComposer(java.lang.String componentComposer)
componentComposer
- string representation of the composer to usepublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- a human-readable description of this componentpublic void setInstantiationStrategy(java.lang.String instantiationStrategy)
instantiationStrategy
- The strategy.public boolean isIsolatedRealm()
public void setComponentSetDescriptor(ComponentSetDescriptor componentSetDescriptor)
componentSetDescriptor
- the component set descriptor of components and dependenciespublic ComponentSetDescriptor getComponentSetDescriptor()
public void setIsolatedRealm(boolean isolatedRealm)
isolatedRealm
- true if this component may be in an isolated classrealmpublic java.lang.String getComponentConfigurator()
public void setComponentConfigurator(java.lang.String componentConfigurator)
componentConfigurator
- The component configurator.public org.codehaus.plexus.classworlds.realm.ClassRealm getRealm()
public void setRealm(org.codehaus.plexus.classworlds.realm.ClassRealm realm)
realm
- the ClassRealm that this component lives underpublic boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object