org.codehaus.plexus.component.repository

Class ComponentRequirement

public class ComponentRequirement extends Object

This represents a component this is required by another component.

Version: $Id: ComponentRequirement.java 6965 2007-10-21 05:32:27Z jvanzyl $

Author: Michal Maczka

Field Summary
StringfieldMappingType
StringfieldName
Stringrole
StringroleHint
Method Summary
booleanequals(Object other)
StringgetFieldMappingType()
Returns the type of the field this component requirement will inject.
StringgetFieldName()
Returns the field name that this component requirement will inject.
StringgetHumanReadableKey()
Returns a human-friendly key, suitable for display.
StringgetRole()
Returns the role of the required component.
StringgetRoleHint()
Returns the role-hint of the required component.
inthashCode()
voidsetFieldMappingType(String fieldType)
Sets the type of the field that will be populated by the required component.
voidsetFieldName(String fieldName)
Sets the name of the field that will be populated by the required component.
voidsetRole(String role)
Sets the role of the require component.
voidsetRoleHint(String roleHint)
Sets the role-hint of the require component.
StringtoString()

Field Detail

fieldMappingType

private String fieldMappingType

fieldName

private String fieldName

role

private String role

roleHint

private String roleHint

Method Detail

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()