org.codehaus.plexus.component.repository

Class ComponentRequirement


public final class ComponentRequirement
extends Object

This represents a component this is required by another component.
Version:
$Id: ComponentRequirement.java 6001 2007-03-05 00:02:24Z handyande $
Author:
Michal Maczka

Method Summary

boolean
equals(Object other)
String
getFieldMappingType()
Returns the type of the field this component requirement will inject.
String
getFieldName()
Returns the field name that this component requirement will inject.
String
getHumanReadableKey()
Returns a human-friendly key, suitable for display.
String
getRole()
Returns the role of the required component.
String
getRoleHint()
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
setRole(String role)
Sets the role of the require component.
void
setRoleHint(String roleHint)
Sets the role-hint of the require component.
String
toString()

Method Details

equals

public boolean equals(Object other)

getFieldMappingType

public String getFieldMappingType()
Returns the type of the field this component requirement will inject.
Returns:
the type of the field this component requirement will inject

getFieldName

public String getFieldName()
Returns the field name that this component requirement will inject.
Returns:
the field name that this component requirement will inject

getHumanReadableKey

public String getHumanReadableKey()
Returns a human-friendly key, suitable for display.
Returns:
a human-friendly key

getRole

public String getRole()
Returns the role of the required component.
Returns:
the role of the required component

getRoleHint

public String getRoleHint()
Returns the role-hint of the required component.
Returns:
the role-hint of the required component

hashCode

public int hashCode()

setFieldMappingType

public void setFieldMappingType(String fieldType)
Sets the type of the field that will be populated by the required component.
Parameters:
fieldType - the type of the field to be populated

setFieldName

public void setFieldName(String fieldName)
Sets the name of the field that will be populated by the required component.
Parameters:
fieldName - the name of the field to be populated

setRole

public void setRole(String role)
Sets the role of the require component.
Parameters:
role - the required component's role

setRoleHint

public void setRoleHint(String roleHint)
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

toString

public String toString()