Class ComponentRequirement
java.lang.Object
org.codehaus.plexus.component.repository.ComponentRequirement
- Direct Known Subclasses:
ComponentRequirementList
This represents a component this is required by another component.
- Version:
- $Id$
- Author:
- Michal Maczka
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the type of the field this component requirement will inject.Returns the field name that this component requirement will inject.Returns a human-friendly key, suitable for display.getRole()
Returns the role of the required component.Returns the role-hint of the required component.int
hashCode()
void
setFieldMappingType
(String fieldType) Sets the type of the field that will be populated by the required component.void
setFieldName
(String fieldName) Sets the name of the field that will be populated by the required component.void
Sets the role of the require component.void
setRoleHint
(String roleHint) Sets the role-hint of the require component.toString()
-
Constructor Details
-
ComponentRequirement
public ComponentRequirement()
-
-
Method Details
-
getFieldName
Returns the field name that this component requirement will inject.- Returns:
- the field name that this component requirement will inject
-
setFieldName
Sets the name of the field that will be populated by the required component.- Parameters:
fieldName
- the name of the field to be populated
-
getRole
Returns the role of the required component.- Returns:
- the role of the required component
-
setRole
Sets the role of the require component.- Parameters:
role
- the required component's role
-
getRoleHint
Returns the role-hint of the required component.- Returns:
- the role-hint of the required component
-
setRoleHint
Sets the role-hint of the require component. Pasing null will set the hint to the default value.- Parameters:
roleHint
- the required component's role-hint
-
getFieldMappingType
Returns the type of the field this component requirement will inject.- Returns:
- the type of the field this component requirement will inject
-
setFieldMappingType
Sets the type of the field that will be populated by the required component.- Parameters:
fieldType
- the type of the field to be populated
-
toString
-
getHumanReadableKey
Returns a human-friendly key, suitable for display.- Returns:
- a human-friendly key
-
equals
-
hashCode
public int hashCode()
-