Top Description Fields Constructors Methods
org.springframework.beans.factory.config

public Class RuntimeBeanReference

extends Object
implements BeanReference
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.config.BeanReference, org.springframework.beans.BeanMetadataElement
Known Direct Subclasses
org.springframework.beans.factory.groovy.GroovyBeanDefinitionReader.GroovyRuntimeBeanReference
Imports
org.springframework.lang.Nullable, org.springframework.util.Assert

Immutable placeholder class used for a property value object when it's a reference to another bean in the factory, to be resolved at runtime.
Authors
Rod Johnson, Juergen Hoeller
See Also
BeanDefinition#getPropertyValues(), org.springframework.beans.factory.BeanFactory#getBean(String), org.springframework.beans.factory.BeanFactory#getBean(Class)

Field Summary

Modifier and TypeField and Description
private final String
private final Class<?>
private Object
private final boolean

Constructor Summary

AccessConstructor and Description
public
RuntimeBeanReference(String
name of the target bean
beanName
)

Create a new RuntimeBeanReference to the given bean name.

public
RuntimeBeanReference(String
name of the target bean
beanName
,
boolean
whether this is an explicit reference to a bean in the parent factory
toParent
)

Create a new RuntimeBeanReference to the given bean name, with the option to mark it as reference to a bean in the parent factory.

public
RuntimeBeanReference(Class<?>
type of the target bean
beanType
)

Create a new RuntimeBeanReference to a bean of the given type.

public
RuntimeBeanReference(Class<?>
type of the target bean
beanType
,
boolean
whether this is an explicit reference to a bean in the parent factory
toParent
)

Create a new RuntimeBeanReference to a bean of the given type, with the option to mark it as reference to a bean in the parent factory.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String
getBeanName()

Implements org.springframework.beans.factory.config.BeanReference.getBeanName.

Return the requested bean name, or the fully-qualified type name in case of by-type resolution.

public Class<?>
getBeanType()

Return the requested bean type if resolution by type is demanded.

public Object
getSource()

Overrides default org.springframework.beans.BeanMetadataElement.getSource.

Return the configuration source Object for this metadata element (may be null).

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isToParent()

Return whether this is an explicit reference to a bean in the parent factory.

public void
setSource(Object source)

Set the configuration source Object for this metadata element.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

beanNameback to summary
private final String beanName
beanTypeback to summary
private final Class<?> beanType
Annotations
@Nullable
sourceback to summary
private Object source
Annotations
@Nullable
toParentback to summary
private final boolean toParent

Constructor Detail

RuntimeBeanReferenceback to summary
public RuntimeBeanReference(String beanName)

Create a new RuntimeBeanReference to the given bean name.

Parameters
beanName:String

name of the target bean

RuntimeBeanReferenceback to summary
public RuntimeBeanReference(String beanName, boolean toParent)

Create a new RuntimeBeanReference to the given bean name, with the option to mark it as reference to a bean in the parent factory.

Parameters
beanName:String

name of the target bean

toParent:boolean

whether this is an explicit reference to a bean in the parent factory

RuntimeBeanReferenceback to summary
public RuntimeBeanReference(Class<?> beanType)

Create a new RuntimeBeanReference to a bean of the given type.

Parameters
beanType:Class<?>

type of the target bean

Since
5.2
RuntimeBeanReferenceback to summary
public RuntimeBeanReference(Class<?> beanType, boolean toParent)

Create a new RuntimeBeanReference to a bean of the given type, with the option to mark it as reference to a bean in the parent factory.

Parameters
beanType:Class<?>

type of the target bean

toParent:boolean

whether this is an explicit reference to a bean in the parent factory

Since
5.2

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getBeanNameback to summary
public String getBeanName()

Implements org.springframework.beans.factory.config.BeanReference.getBeanName.

Return the requested bean name, or the fully-qualified type name in case of by-type resolution.

Annotations
@Override
See Also
getBeanType()
getBeanTypeback to summary
public Class<?> getBeanType()

Return the requested bean type if resolution by type is demanded.

Annotations
@Nullable
Since
5.2
getSourceback to summary
public Object getSource()

Overrides default org.springframework.beans.BeanMetadataElement.getSource.

Doc from org.springframework.beans.BeanMetadataElement.getSource.

Return the configuration source Object for this metadata element (may be null).

Annotations
@Override
@Nullable
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isToParentback to summary
public boolean isToParent()

Return whether this is an explicit reference to a bean in the parent factory.

setSourceback to summary
public void setSource(Object source)

Set the configuration source Object for this metadata element.

The exact type of the object will depend on the configuration mechanism used.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override