|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.component.repository.ComponentDescriptor
public class ComponentDescriptor
Component instantiation description.
Field Summary | |
---|---|
private java.lang.String |
alias
|
private java.lang.String |
componentComposer
|
private java.lang.String |
componentConfigurator
|
private java.lang.String |
componentFactory
|
private java.lang.String |
componentProfile
|
private ComponentSetDescriptor |
componentSetDescriptor
|
private java.lang.String |
componentType
|
private PlexusConfiguration |
configuration
|
private java.util.List |
dependencies
|
private java.lang.String |
description
|
private java.lang.String |
implementation
|
private java.lang.String |
instantiationStrategy
|
private boolean |
isolatedRealm
|
private java.lang.String |
lifecycleHandler
|
private java.lang.String |
realmId
|
private java.util.List |
requirements
|
private java.lang.String |
role
|
private java.lang.String |
roleHint
|
private java.lang.String |
source
|
private java.lang.String |
version
|
Constructor Summary | |
---|---|
ComponentDescriptor()
|
Method Summary | |
---|---|
void |
addRequirement(ComponentRequirement requirement)
Add a project requirement to this component. |
void |
addRequirements(java.util.List 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. |
PlexusConfiguration |
getConfiguration()
Returns configuration values defined for this component. |
java.util.List |
getDependencies()
Returns a List of dependencies of 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.String |
getInstantiationStrategy()
Returns the type of instantiation strategy for this component. |
java.lang.String |
getLifecycleHandler()
Returns the lifecycle-handler for this component. |
java.lang.String |
getRealmId()
The ClassRealm that this component lives under. |
java.util.List |
getRequirements()
Returns all project requirements of this component. |
java.lang.String |
getRole()
Returns the role of this component. |
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 |
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(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 |
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 |
setRealmId(java.lang.String realmId)
Set the id of the ClassRealm that this component lives under. |
void |
setRole(java.lang.String role)
Sets the role of this component. |
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()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private java.lang.String alias
private java.lang.String role
private java.lang.String roleHint
private java.lang.String implementation
private java.lang.String version
private java.lang.String componentType
private PlexusConfiguration configuration
private java.lang.String instantiationStrategy
private java.lang.String lifecycleHandler
private java.lang.String componentProfile
private java.util.List requirements
private java.lang.String componentFactory
private java.lang.String componentComposer
private java.lang.String componentConfigurator
private java.lang.String description
private java.lang.String realmId
private boolean isolatedRealm
private java.util.List dependencies
private ComponentSetDescriptor componentSetDescriptor
private java.lang.String source
Constructor Detail |
---|
public ComponentDescriptor()
Method Detail |
---|
public void setSource(java.lang.String source)
public java.lang.String getSource()
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 void setRole(java.lang.String role)
role
- this component's rolepublic 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.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 PlexusConfiguration getConfiguration()
public void setConfiguration(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 addRequirements(java.util.List requirements)
requirements
- the requirements to addpublic java.util.List getRequirements()
public java.lang.String getComponentFactory()
public void setComponentFactory(java.lang.String componentFactory)
componentFactory
- 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
- 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.util.List getDependencies()
public java.lang.String getComponentConfigurator()
public void setComponentConfigurator(java.lang.String componentConfigurator)
componentConfigurator
- public java.lang.String getRealmId()
public void setRealmId(java.lang.String realmId)
realmId
- ClassRealm idpublic 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |