public class ComponentDescriptor extends Object
Constructor and Description |
---|
ComponentDescriptor() |
Modifier and Type | Method and Description |
---|---|
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 |
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(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 |
setVersion(String version)
Sets the point in a components's project development timeline
|
String |
toString() |
public String getHumanReadableKey()
public String getAlias()
public void setAlias(String alias)
alias
- alternate name to setpublic String getRole()
public void setRole(String role)
role
- this component's rolepublic String getRoleHint()
public void setRoleHint(String roleHint)
roleHint
- this component's role-hintpublic String getImplementation()
public void setImplementation(String implementation)
implementation
- string denoting a FQCN in normal Java components,
or some other name or file for other component factory implementationspublic String getVersion()
public void setVersion(String version)
version
- the components's versionpublic String getComponentType()
public void setComponentType(String componentType)
componentType
- the type to setpublic String getInstantiationStrategy()
public PlexusConfiguration getConfiguration()
public void setConfiguration(PlexusConfiguration configuration)
configuration
- the configuration hierarchy to setpublic boolean hasConfiguration()
public String getLifecycleHandler()
public void setLifecycleHandler(String lifecycleHandler)
lifecycleHandler
- the lifecycle handler string to setpublic String getComponentProfile()
public void setComponentProfile(String componentProfile)
public void addRequirement(ComponentRequirement requirement)
requirement
- the requirement to addpublic void addRequirements(List requirements)
requirements
- the requirements to addpublic List getRequirements()
public String getComponentFactory()
public void setComponentFactory(String componentFactory)
componentFactory
- public String getComponentComposer()
public void setComponentComposer(String componentComposer)
componentComposer
- string representation of the composer to usepublic String getDescription()
public void setDescription(String description)
description
- a human-readable description of this componentpublic void setInstantiationStrategy(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 List getDependencies()
public String getComponentConfigurator()
public void setComponentConfigurator(String componentConfigurator)
componentConfigurator
- public String getRealmId()
public void setRealmId(String realmId)
realmId
- ClassRealm idCopyright © 2019. All rights reserved.