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$
Author:
Michal Maczka
  • Constructor Details

    • ComponentRequirement

      public ComponentRequirement()
  • Method Details

    • 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