Class BeanComponentDefinition
- java.lang.Object
- org.springframework.beans.factory.config.BeanDefinitionHolder
- org.springframework.beans.factory.parsing.BeanComponentDefinition
- All Implemented Interfaces:
BeanMetadataElement,ComponentDefinition
public class BeanComponentDefinition extends BeanDefinitionHolder implements ComponentDefinition
ComponentDefinition based on a standard BeanDefinition, exposing the given bean definition as well as inner bean definitions and bean references for the given bean.- Since:
- 2.0
- Author:
- Rob Harrop, Juergen Hoeller
Constructor Summary
Constructors Constructor Description BeanComponentDefinition(BeanDefinitionHolder holder)Create a new BeanComponentDefinition for the given bean.BeanComponentDefinition(BeanDefinition beanDefinition, String beanName)Create a new BeanComponentDefinition for the given bean.BeanComponentDefinition(BeanDefinition beanDefinition, String beanName, String[] aliases)Create a new BeanComponentDefinition for the given bean.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object other)This implementations expects the other object to be of type BeanComponentDefinition as well, in addition to the superclass's equality requirements.BeanDefinition[]getBeanDefinitions()Return theBeanDefinitionsthat were registered to form thisComponentDefinition.BeanReference[]getBeanReferences()Return the set ofBeanReferencesthat are considered to be important to thisComponentDefinition.StringgetDescription()Return a friendly description of the described component.BeanDefinition[]getInnerBeanDefinitions()Return theBeanDefinitionsthat represent all relevant inner beans within this component.StringgetName()Get the user-visible name of thisComponentDefinition.StringtoString()This implementation returns this ComponentDefinition's description.Methods inherited from class org.springframework.beans.factory.config.BeanDefinitionHolder
getAliases, getBeanDefinition, getBeanName, getLongDescription, getShortDescription, getSource, hashCode, matchesName
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.beans.BeanMetadataElement
getSource
Constructor Detail
BeanComponentDefinition
public BeanComponentDefinition(BeanDefinition beanDefinition, String beanName)
Create a new BeanComponentDefinition for the given bean.- Parameters:
beanDefinition- the BeanDefinitionbeanName- the name of the bean
BeanComponentDefinition
public BeanComponentDefinition(BeanDefinition beanDefinition, String beanName, String[] aliases)
Create a new BeanComponentDefinition for the given bean.- Parameters:
beanDefinition- the BeanDefinitionbeanName- the name of the beanaliases- alias names for the bean, ornullif none
BeanComponentDefinition
public BeanComponentDefinition(BeanDefinitionHolder holder)
Create a new BeanComponentDefinition for the given bean.- Parameters:
holder- the BeanDefinitionHolder encapsulating the bean definition as well as the name of the bean
Method Detail
getName
public String getName()
Description copied from interface:ComponentDefinitionGet the user-visible name of thisComponentDefinition.This should link back directly to the corresponding configuration data for this component in a given context.
- Specified by:
getNamein interfaceComponentDefinition
getDescription
public String getDescription()
Description copied from interface:ComponentDefinitionReturn a friendly description of the described component.Implementations are encouraged to return the same value from
toString().- Specified by:
getDescriptionin interfaceComponentDefinition
getBeanDefinitions
public BeanDefinition[] getBeanDefinitions()
Description copied from interface:ComponentDefinitionReturn theBeanDefinitionsthat were registered to form thisComponentDefinition.It should be noted that a
ComponentDefinitionmay well be related with otherBeanDefinitionsviareferences, however these are not included as they may be not available immediately. ImportantBeanReferencesare available fromComponentDefinition.getBeanReferences().- Specified by:
getBeanDefinitionsin interfaceComponentDefinition- Returns:
- the array of BeanDefinitions, or an empty array if none
getInnerBeanDefinitions
public BeanDefinition[] getInnerBeanDefinitions()
Description copied from interface:ComponentDefinitionReturn theBeanDefinitionsthat represent all relevant inner beans within this component.Other inner beans may exist within the associated
BeanDefinitions, however these are not considered to be needed for validation or for user visualization.- Specified by:
getInnerBeanDefinitionsin interfaceComponentDefinition- Returns:
- the array of BeanDefinitions, or an empty array if none
getBeanReferences
public BeanReference[] getBeanReferences()
Description copied from interface:ComponentDefinitionReturn the set ofBeanReferencesthat are considered to be important to thisComponentDefinition.Other
BeanReferencesmay exist within the associatedBeanDefinitions, however these are not considered to be needed for validation or for user visualization.- Specified by:
getBeanReferencesin interfaceComponentDefinition- Returns:
- the array of BeanReferences, or an empty array if none
toString
public String toString()
This implementation returns this ComponentDefinition's description.- Overrides:
toStringin classBeanDefinitionHolder- See Also:
getDescription()
equals
public boolean equals(Object other)
This implementations expects the other object to be of type BeanComponentDefinition as well, in addition to the superclass's equality requirements.- Overrides:
equalsin classBeanDefinitionHolder