org.codehaus.plexus.component.repository
Class ComponentRequirement

java.lang.Object
  org.codehaus.plexus.component.repository.ComponentRequirement

Direct Known Subclasses:

ComponentRequirementList

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

Constructor Summary

ComponentRequirement()

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComponentRequirement

public ComponentRequirement()

Method Detail

getFieldName

public String getFieldName()

Returns the field name that this component requirement will inject.

Returns:

the field name that this component requirement will inject

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

getRole

public String getRole()

Returns the role of the required component.

Returns:

the role of the required component

setRole

public void setRole(String role)

Sets the role of the require component.

Parameters:

role - the required component's role

getRoleHint

public String getRoleHint()

Returns the role-hint of the required component.

Returns:

the role-hint of the required component

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

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

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

toString

public String toString()

Overrides:

toString in class Object

getHumanReadableKey

public String getHumanReadableKey()

Returns a human-friendly key, suitable for display.

Returns:

a human-friendly key

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object