Replace 'e.g.' with 'for example' in documentation and comments
Closes gh-33515
This commit is contained in:
committed by
Sam Brannen
parent
e55fe9077f
commit
8941e2876e
@@ -474,7 +474,7 @@ public abstract class AbstractNestablePropertyAccessor extends AbstractPropertyA
|
||||
else {
|
||||
Throwable cause = ex.getTargetException();
|
||||
if (cause instanceof UndeclaredThrowableException) {
|
||||
// May happen e.g. with Groovy-generated methods
|
||||
// May happen, for example, with Groovy-generated methods
|
||||
cause = cause.getCause();
|
||||
}
|
||||
throw new MethodInvocationException(propertyChangeEvent, cause);
|
||||
|
||||
@@ -23,7 +23,7 @@ import org.springframework.lang.Nullable;
|
||||
|
||||
/**
|
||||
* Strategy interface for creating {@link BeanInfo} instances for Spring beans.
|
||||
* Can be used to plug in custom bean property resolution strategies (e.g. for other
|
||||
* Can be used to plug in custom bean property resolution strategies (for example, for other
|
||||
* languages on the JVM) or more efficient {@link BeanInfo} retrieval algorithms.
|
||||
*
|
||||
* <p>BeanInfoFactories are instantiated by the {@link CachedIntrospectionResults},
|
||||
|
||||
@@ -125,7 +125,7 @@ public abstract class BeanUtils {
|
||||
* The cause may notably indicate a {@link NoSuchMethodException} if no
|
||||
* primary/default constructor was found, a {@link NoClassDefFoundError}
|
||||
* or other {@link LinkageError} in case of an unresolvable class definition
|
||||
* (e.g. due to a missing dependency at runtime), or an exception thrown
|
||||
* (for example, due to a missing dependency at runtime), or an exception thrown
|
||||
* from the constructor invocation itself.
|
||||
* @see Constructor#newInstance
|
||||
*/
|
||||
@@ -248,7 +248,7 @@ public abstract class BeanUtils {
|
||||
// No public constructors -> check non-public
|
||||
ctors = clazz.getDeclaredConstructors();
|
||||
if (ctors.length == 1) {
|
||||
// A single non-public constructor, e.g. from a non-public record type
|
||||
// A single non-public constructor, for example, from a non-public record type
|
||||
return (Constructor<T>) ctors[0];
|
||||
}
|
||||
}
|
||||
@@ -538,7 +538,7 @@ public abstract class BeanUtils {
|
||||
|
||||
/**
|
||||
* Find a JavaBeans PropertyEditor following the 'Editor' suffix convention
|
||||
* (e.g. "mypackage.MyDomainClass" → "mypackage.MyDomainClassEditor").
|
||||
* (for example, "mypackage.MyDomainClass" → "mypackage.MyDomainClassEditor").
|
||||
* <p>Compatible to the standard JavaBeans convention as implemented by
|
||||
* {@link java.beans.PropertyEditorManager} but isolated from the latter's
|
||||
* registered default editors for primitive types.
|
||||
@@ -560,7 +560,7 @@ public abstract class BeanUtils {
|
||||
}
|
||||
}
|
||||
catch (Throwable ex) {
|
||||
// e.g. AccessControlException on Google App Engine
|
||||
// for example, AccessControlException on Google App Engine
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -107,7 +107,7 @@ public final class CachedIntrospectionResults {
|
||||
* Accept the given ClassLoader as cache-safe, even if its classes would
|
||||
* not qualify as cache-safe in this CachedIntrospectionResults class.
|
||||
* <p>This configuration method is only relevant in scenarios where the Spring
|
||||
* classes reside in a 'common' ClassLoader (e.g. the system ClassLoader)
|
||||
* classes reside in a 'common' ClassLoader (for example, the system ClassLoader)
|
||||
* whose lifecycle is not coupled to the application. In such a scenario,
|
||||
* CachedIntrospectionResults would by default not cache any of the application's
|
||||
* classes, since they would create a leak in the common ClassLoader.
|
||||
@@ -290,7 +290,7 @@ public final class CachedIntrospectionResults {
|
||||
currClass = currClass.getSuperclass();
|
||||
}
|
||||
|
||||
// Check for record-style accessors without prefix: e.g. "lastName()"
|
||||
// Check for record-style accessors without prefix: for example, "lastName()"
|
||||
// - accessor method directly referring to instance field of same name
|
||||
// - same convention for component accessors of Java 15 record classes
|
||||
introspectPlainAccessors(beanClass, readMethodNames);
|
||||
|
||||
@@ -41,7 +41,7 @@ import org.springframework.lang.Nullable;
|
||||
import org.springframework.util.ObjectUtils;
|
||||
|
||||
/**
|
||||
* Decorator for a standard {@link BeanInfo} object, e.g. as created by
|
||||
* Decorator for a standard {@link BeanInfo} object, for example, as created by
|
||||
* {@link Introspector#getBeanInfo(Class)}, designed to discover and register
|
||||
* static and/or non-void returning setter methods. For example:
|
||||
*
|
||||
|
||||
@@ -20,7 +20,7 @@ import org.springframework.lang.Nullable;
|
||||
|
||||
/**
|
||||
* Thrown on an unrecoverable problem encountered in the
|
||||
* beans packages or sub-packages, e.g. bad class or field.
|
||||
* beans packages or sub-packages, for example, bad class or field.
|
||||
*
|
||||
* @author Rod Johnson
|
||||
*/
|
||||
|
||||
@@ -21,7 +21,7 @@ import org.springframework.lang.Nullable;
|
||||
|
||||
/**
|
||||
* Exception thrown when a BeanFactory encounters an invalid bean definition:
|
||||
* e.g. in case of incomplete or contradictory bean metadata.
|
||||
* for example, in case of incomplete or contradictory bean metadata.
|
||||
*
|
||||
* @author Rod Johnson
|
||||
* @author Juergen Hoeller
|
||||
|
||||
@@ -36,7 +36,7 @@ import org.springframework.lang.Nullable;
|
||||
* singleton in the scope of the factory). Which type of instance will be returned
|
||||
* depends on the bean factory configuration: the API is the same. Since Spring
|
||||
* 2.0, further scopes are available depending on the concrete application
|
||||
* context (e.g. "request" and "session" scopes in a web environment).
|
||||
* context (for example, "request" and "session" scopes in a web environment).
|
||||
*
|
||||
* <p>The point of this approach is that the BeanFactory is a central registry
|
||||
* of application components, and centralizes configuration of application
|
||||
|
||||
@@ -18,7 +18,7 @@ package org.springframework.beans.factory;
|
||||
|
||||
/**
|
||||
* Interface to be implemented by beans that need to react once all their properties
|
||||
* have been set by a {@link BeanFactory}: e.g. to perform custom initialization,
|
||||
* have been set by a {@link BeanFactory}: for example, to perform custom initialization,
|
||||
* or merely to check that all mandatory properties have been set.
|
||||
*
|
||||
* <p>An alternative to implementing {@code InitializingBean} is specifying a custom
|
||||
|
||||
@@ -38,10 +38,10 @@ import org.springframework.lang.Nullable;
|
||||
* iteration and allows for collection-style {@link #stream} access.
|
||||
*
|
||||
* <p>As of 6.2, this interface declares default implementations for all methods.
|
||||
* This makes it easier to implement in a custom fashion, e.g. for unit tests.
|
||||
* This makes it easier to implement in a custom fashion, for example, for unit tests.
|
||||
* For typical purposes, implement {@link #stream()} to enable all other methods.
|
||||
* Alternatively, you may implement the specific methods that your callers expect,
|
||||
* e.g. just {@link #getObject()} or {@link #getIfAvailable()}.
|
||||
* for example, just {@link #getObject()} or {@link #getIfAvailable()}.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
* @since 4.3
|
||||
|
||||
@@ -21,7 +21,7 @@ package org.springframework.beans.factory;
|
||||
* during {@link BeanFactory} bootstrap. This interface can be implemented by
|
||||
* singleton beans in order to perform some initialization after the regular
|
||||
* singleton instantiation algorithm, avoiding side effects with accidental early
|
||||
* initialization (e.g. from {@link ListableBeanFactory#getBeansOfType} calls).
|
||||
* initialization (for example, from {@link ListableBeanFactory#getBeansOfType} calls).
|
||||
* In that sense, it is an alternative to {@link InitializingBean} which gets
|
||||
* triggered right at the end of a bean's local construction phase.
|
||||
*
|
||||
|
||||
@@ -50,7 +50,7 @@ public abstract class BeanFactoryAnnotationUtils {
|
||||
|
||||
/**
|
||||
* Retrieve all beans of type {@code T} from the given {@code BeanFactory} declaring a
|
||||
* qualifier (e.g. via {@code <qualifier>} or {@code @Qualifier}) matching the given
|
||||
* qualifier (for example, via {@code <qualifier>} or {@code @Qualifier}) matching the given
|
||||
* qualifier, or having a bean name matching the given qualifier.
|
||||
* @param beanFactory the factory to get the target beans from (also searching ancestors)
|
||||
* @param beanType the type of beans to retrieve
|
||||
@@ -75,7 +75,7 @@ public abstract class BeanFactoryAnnotationUtils {
|
||||
|
||||
/**
|
||||
* Obtain a bean of type {@code T} from the given {@code BeanFactory} declaring a
|
||||
* qualifier (e.g. via {@code <qualifier>} or {@code @Qualifier}) matching the given
|
||||
* qualifier (for example, via {@code <qualifier>} or {@code @Qualifier}) matching the given
|
||||
* qualifier, or having a bean name matching the given qualifier.
|
||||
* @param beanFactory the factory to get the target bean from (also searching ancestors)
|
||||
* @param beanType the type of bean to retrieve
|
||||
@@ -109,7 +109,7 @@ public abstract class BeanFactoryAnnotationUtils {
|
||||
|
||||
/**
|
||||
* Obtain a bean of type {@code T} from the given {@code BeanFactory} declaring a qualifier
|
||||
* (e.g. {@code <qualifier>} or {@code @Qualifier}) matching the given qualifier).
|
||||
* (for example, {@code <qualifier>} or {@code @Qualifier}) matching the given qualifier).
|
||||
* @param bf the factory to get the target bean from
|
||||
* @param beanType the type of bean to retrieve
|
||||
* @param qualifier the qualifier for selecting between multiple bean matches
|
||||
|
||||
@@ -153,7 +153,7 @@ public final class ParameterResolutionDelegate {
|
||||
* an empty {@code AnnotatedElement}.
|
||||
* <h4>WARNING</h4>
|
||||
* <p>The {@code AnnotatedElement} returned by this method should never be cast and
|
||||
* treated as a {@code Parameter} since the metadata (e.g., {@link Parameter#getName()},
|
||||
* treated as a {@code Parameter} since the metadata (for example, {@link Parameter#getName()},
|
||||
* {@link Parameter#getType()}, etc.) will not match those for the declared parameter
|
||||
* at the given index in an inner class constructor.
|
||||
* @return the supplied {@code parameter} or the <em>effective</em> {@code Parameter}
|
||||
|
||||
@@ -105,7 +105,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory {
|
||||
/**
|
||||
* Suffix for the "original instance" convention when initializing an existing
|
||||
* bean instance: to be appended to the fully-qualified bean class name,
|
||||
* e.g. "com.mypackage.MyClass.ORIGINAL", in order to enforce the given instance
|
||||
* for example, "com.mypackage.MyClass.ORIGINAL", in order to enforce the given instance
|
||||
* to be returned, i.e. no proxies etc.
|
||||
* @since 5.1
|
||||
* @see #initializeBean(Object, String)
|
||||
@@ -128,7 +128,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory {
|
||||
* Constructor resolution is based on Kotlin primary / single public / single non-public,
|
||||
* with a fallback to the default constructor in ambiguous scenarios, also influenced
|
||||
* by {@link SmartInstantiationAwareBeanPostProcessor#determineCandidateConstructors}
|
||||
* (e.g. for annotation-driven constructor selection).
|
||||
* (for example, for annotation-driven constructor selection).
|
||||
* @param beanClass the class of the bean to create
|
||||
* @return the new bean instance
|
||||
* @throws BeansException if instantiation or wiring failed
|
||||
@@ -137,7 +137,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory {
|
||||
|
||||
/**
|
||||
* Populate the given bean instance through applying after-instantiation callbacks
|
||||
* and bean property post-processing (e.g. for annotation-driven injection).
|
||||
* and bean property post-processing (for example, for annotation-driven injection).
|
||||
* <p>Note: This is essentially intended for (re-)populating annotated fields and
|
||||
* methods, either for new instances or for deserialized instances. It does
|
||||
* <i>not</i> imply traditional by-name or by-type autowiring of properties;
|
||||
@@ -196,7 +196,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory {
|
||||
* Instantiate a new bean instance of the given class with the specified autowire
|
||||
* strategy. All constants defined in this interface are supported here.
|
||||
* Can also be invoked with {@code AUTOWIRE_NO} in order to just apply
|
||||
* before-instantiation callbacks (e.g. for annotation-driven injection).
|
||||
* before-instantiation callbacks (for example, for annotation-driven injection).
|
||||
* <p>Does <i>not</i> apply standard {@link BeanPostProcessor BeanPostProcessors}
|
||||
* callbacks or perform any further initialization of the bean. This interface
|
||||
* offers distinct, fine-grained operations for those purposes, for example
|
||||
@@ -223,7 +223,7 @@ public interface AutowireCapableBeanFactory extends BeanFactory {
|
||||
/**
|
||||
* Autowire the bean properties of the given bean instance by name or type.
|
||||
* Can also be invoked with {@code AUTOWIRE_NO} in order to just apply
|
||||
* after-instantiation callbacks (e.g. for annotation-driven injection).
|
||||
* after-instantiation callbacks (for example, for annotation-driven injection).
|
||||
* <p>Does <i>not</i> apply standard {@link BeanPostProcessor BeanPostProcessors}
|
||||
* callbacks or perform any further initialization of the bean. This interface
|
||||
* offers distinct, fine-grained operations for those purposes, for example
|
||||
|
||||
@@ -241,7 +241,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single
|
||||
boolean hasEmbeddedValueResolver();
|
||||
|
||||
/**
|
||||
* Resolve the given embedded value, e.g. an annotation attribute.
|
||||
* Resolve the given embedded value, for example, an annotation attribute.
|
||||
* @param value the value to resolve
|
||||
* @return the resolved value (may be the original value as-is)
|
||||
* @since 3.0
|
||||
@@ -255,7 +255,7 @@ public interface ConfigurableBeanFactory extends HierarchicalBeanFactory, Single
|
||||
* <p>Note: Post-processors submitted here will be applied in the order of
|
||||
* registration; any ordering semantics expressed through implementing the
|
||||
* {@link org.springframework.core.Ordered} interface will be ignored. Note
|
||||
* that autodetected post-processors (e.g. as beans in an ApplicationContext)
|
||||
* that autodetected post-processors (for example, as beans in an ApplicationContext)
|
||||
* will always be applied after programmatically registered ones.
|
||||
* @param beanPostProcessor the post-processor to register
|
||||
*/
|
||||
|
||||
@@ -66,13 +66,13 @@ public interface ConfigurableListableBeanFactory
|
||||
* Register a special dependency type with corresponding autowired value.
|
||||
* <p>This is intended for factory/context references that are supposed
|
||||
* to be autowirable but are not defined as beans in the factory:
|
||||
* e.g. a dependency of type ApplicationContext resolved to the
|
||||
* for example, a dependency of type ApplicationContext resolved to the
|
||||
* ApplicationContext instance that the bean is living in.
|
||||
* <p>Note: There are no such default types registered in a plain BeanFactory,
|
||||
* not even for the BeanFactory interface itself.
|
||||
* @param dependencyType the dependency type to register. This will typically
|
||||
* be a base interface such as BeanFactory, with extensions of it resolved
|
||||
* as well if declared as an autowiring dependency (e.g. ListableBeanFactory),
|
||||
* as well if declared as an autowiring dependency (for example, ListableBeanFactory),
|
||||
* as long as the given value actually implements the extended interface.
|
||||
* @param autowiredValue the corresponding autowired value. This may also be an
|
||||
* implementation of the {@link org.springframework.beans.factory.ObjectFactory}
|
||||
@@ -126,7 +126,7 @@ public interface ConfigurableListableBeanFactory
|
||||
* Clear the merged bean definition cache, removing entries for beans
|
||||
* which are not considered eligible for full metadata caching yet.
|
||||
* <p>Typically triggered after changes to the original bean definitions,
|
||||
* e.g. after applying a {@link BeanFactoryPostProcessor}. Note that metadata
|
||||
* for example, after applying a {@link BeanFactoryPostProcessor}. Note that metadata
|
||||
* for beans which have already been created at this point will be kept around.
|
||||
* @since 4.2
|
||||
* @see #getBeanDefinition
|
||||
|
||||
@@ -76,7 +76,7 @@ import org.springframework.util.ClassUtils;
|
||||
*
|
||||
* <p>
|
||||
* Also supports "java.lang.String[]"-style array class names and primitive
|
||||
* class names (e.g. "boolean"). Delegates to {@link ClassUtils} for actual
|
||||
* class names (for example, "boolean"). Delegates to {@link ClassUtils} for actual
|
||||
* class name resolution.
|
||||
*
|
||||
* <p><b>NOTE:</b> Custom property editors registered with this configurer do
|
||||
|
||||
@@ -180,7 +180,7 @@ public class DependencyDescriptor extends InjectionPoint implements Serializable
|
||||
|
||||
/**
|
||||
* Check whether the underlying field is annotated with any variant of a
|
||||
* {@code Nullable} annotation, e.g. {@code jakarta.annotation.Nullable} or
|
||||
* {@code Nullable} annotation, for example, {@code jakarta.annotation.Nullable} or
|
||||
* {@code edu.umd.cs.findbugs.annotations.Nullable}.
|
||||
*/
|
||||
private boolean hasNullableAnnotation() {
|
||||
@@ -381,7 +381,7 @@ public class DependencyDescriptor extends InjectionPoint implements Serializable
|
||||
|
||||
/**
|
||||
* Determine whether this dependency supports lazy resolution,
|
||||
* e.g. through extra proxying. The default is {@code true}.
|
||||
* for example, through extra proxying. The default is {@code true}.
|
||||
* @since 6.1.2
|
||||
* @see org.springframework.beans.factory.support.AutowireCandidateResolver#getLazyResolutionProxyIfNecessary
|
||||
*/
|
||||
|
||||
@@ -31,7 +31,7 @@ public interface DestructionAwareBeanPostProcessor extends BeanPostProcessor {
|
||||
|
||||
/**
|
||||
* Apply this BeanPostProcessor to the given bean instance before its
|
||||
* destruction, e.g. invoking custom destruction callbacks.
|
||||
* destruction, for example, invoking custom destruction callbacks.
|
||||
* <p>Like DisposableBean's {@code destroy} and a custom destroy method, this
|
||||
* callback will only apply to beans which the container fully manages the
|
||||
* lifecycle for. This is usually the case for singletons and scoped beans.
|
||||
|
||||
@@ -140,7 +140,7 @@ public class FieldRetrievingFactoryBean
|
||||
|
||||
/**
|
||||
* Set a fully qualified static field name to retrieve,
|
||||
* e.g. "example.MyExampleClass.MY_EXAMPLE_FIELD".
|
||||
* for example, "example.MyExampleClass.MY_EXAMPLE_FIELD".
|
||||
* Convenient alternative to specifying targetClass and targetField.
|
||||
* @see #setTargetClass
|
||||
* @see #setTargetField
|
||||
@@ -190,7 +190,7 @@ public class FieldRetrievingFactoryBean
|
||||
if (lastDotIndex == -1 || lastDotIndex == this.staticField.length()) {
|
||||
throw new IllegalArgumentException(
|
||||
"staticField must be a fully qualified class plus static field name: " +
|
||||
"e.g. 'example.MyExampleClass.MY_EXAMPLE_FIELD'");
|
||||
"for example, 'example.MyExampleClass.MY_EXAMPLE_FIELD'");
|
||||
}
|
||||
String className = this.staticField.substring(0, lastDotIndex);
|
||||
String fieldName = this.staticField.substring(lastDotIndex + 1);
|
||||
|
||||
@@ -180,7 +180,7 @@ public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfi
|
||||
|
||||
/**
|
||||
* Set a value that should be treated as {@code null} when resolved
|
||||
* as a placeholder value: e.g. "" (empty String) or "null".
|
||||
* as a placeholder value: for example, "" (empty String) or "null".
|
||||
* <p>Note that this will only apply to full property values,
|
||||
* not to parts of concatenated values.
|
||||
* <p>By default, no such null value is defined. This means that
|
||||
|
||||
@@ -121,7 +121,7 @@ public class PropertyPathFactoryBean implements FactoryBean<Object>, BeanNameAwa
|
||||
* Specify the name of a target bean to apply the property path to.
|
||||
* Alternatively, specify a target object directly.
|
||||
* @param targetBeanName the bean name to be looked up in the
|
||||
* containing bean factory (e.g. "testBean")
|
||||
* containing bean factory (for example, "testBean")
|
||||
* @see #setTargetObject
|
||||
*/
|
||||
public void setTargetBeanName(String targetBeanName) {
|
||||
@@ -131,7 +131,7 @@ public class PropertyPathFactoryBean implements FactoryBean<Object>, BeanNameAwa
|
||||
/**
|
||||
* Specify the property path to apply to the target.
|
||||
* @param propertyPath the property path, potentially nested
|
||||
* (e.g. "age" or "spouse.age")
|
||||
* (for example, "age" or "spouse.age")
|
||||
*/
|
||||
public void setPropertyPath(String propertyPath) {
|
||||
this.propertyPath = StringUtils.trimAllWhitespace(propertyPath);
|
||||
|
||||
@@ -93,7 +93,7 @@ public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport
|
||||
|
||||
/**
|
||||
* Set the system property mode by the name of the corresponding constant,
|
||||
* e.g. "SYSTEM_PROPERTIES_MODE_OVERRIDE".
|
||||
* for example, "SYSTEM_PROPERTIES_MODE_OVERRIDE".
|
||||
* @param constantName name of the constant
|
||||
* @see #setSystemPropertiesMode
|
||||
*/
|
||||
|
||||
@@ -31,7 +31,7 @@ import org.springframework.lang.Nullable;
|
||||
* <p>{@link org.springframework.context.ApplicationContext} implementations
|
||||
* such as a {@link org.springframework.web.context.WebApplicationContext}
|
||||
* may register additional standard scopes specific to their environment,
|
||||
* e.g. {@link org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST "request"}
|
||||
* for example, {@link org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST "request"}
|
||||
* and {@link org.springframework.web.context.WebApplicationContext#SCOPE_SESSION "session"},
|
||||
* based on this Scope SPI.
|
||||
*
|
||||
@@ -125,7 +125,7 @@ public interface Scope {
|
||||
|
||||
/**
|
||||
* Resolve the contextual object for the given key, if any.
|
||||
* E.g. the HttpServletRequest object for key "request".
|
||||
* For example, the HttpServletRequest object for key "request".
|
||||
* @param key the contextual key
|
||||
* @return the corresponding object, or {@code null} if none found
|
||||
* @throws IllegalStateException if the underlying scope is not currently active
|
||||
|
||||
@@ -77,7 +77,7 @@ public abstract class YamlProcessor {
|
||||
* A map of document matchers allowing callers to selectively use only
|
||||
* some of the documents in a YAML resource. In YAML documents are
|
||||
* separated by {@code ---} lines, and each document is converted
|
||||
* to properties before the match is made. E.g.
|
||||
* to properties before the match is made. For example,
|
||||
* <pre class="code">
|
||||
* environment: dev
|
||||
* url: https://dev.bar.com
|
||||
|
||||
@@ -32,7 +32,7 @@ import org.springframework.lang.Nullable;
|
||||
* has a lot of similar features.
|
||||
*
|
||||
* <p><b>Note: All exposed values are of type {@code String}</b> for access through
|
||||
* the common {@link Properties#getProperty} method (e.g. in configuration property
|
||||
* the common {@link Properties#getProperty} method (for example, in configuration property
|
||||
* resolution through {@link PropertyResourceConfigurer#setProperties(Properties)}).
|
||||
* If this is not desirable, use {@link YamlMapFactoryBean} instead.
|
||||
*
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.springframework.beans.factory.config.BeanReference;
|
||||
* it is now possible for a single logical configuration entity, in this case an XML tag, to
|
||||
* create multiple {@link BeanDefinition BeanDefinitions} and {@link BeanReference RuntimeBeanReferences}
|
||||
* in order to provide more succinct configuration and greater convenience to end users. As such, it can
|
||||
* no longer be assumed that each configuration entity (e.g. XML tag) maps to one {@link BeanDefinition}.
|
||||
* no longer be assumed that each configuration entity (for example, XML tag) maps to one {@link BeanDefinition}.
|
||||
* For tool vendors and other users who wish to present visualization or support for configuring Spring
|
||||
* applications it is important that there is some mechanism in place to tie the {@link BeanDefinition BeanDefinitions}
|
||||
* in the {@link org.springframework.beans.factory.BeanFactory} back to the configuration data in a way
|
||||
|
||||
@@ -205,7 +205,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac
|
||||
|
||||
/**
|
||||
* Set the ParameterNameDiscoverer to use for resolving method parameter
|
||||
* names if needed (e.g. for constructor names).
|
||||
* names if needed (for example, for constructor names).
|
||||
* <p>Default is a {@link DefaultParameterNameDiscoverer}.
|
||||
*/
|
||||
public void setParameterNameDiscoverer(@Nullable ParameterNameDiscoverer parameterNameDiscoverer) {
|
||||
@@ -539,7 +539,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac
|
||||
|
||||
/**
|
||||
* Actually create the specified bean. Pre-creation processing has already happened
|
||||
* at this point, e.g. checking {@code postProcessBeforeInstantiation} callbacks.
|
||||
* at this point, for example, checking {@code postProcessBeforeInstantiation} callbacks.
|
||||
* <p>Differentiates between default bean instantiation, use of a
|
||||
* factory method, and autowiring a constructor.
|
||||
* @param beanName the name of the bean
|
||||
@@ -821,7 +821,7 @@ public abstract class AbstractAutowireCapableBeanFactory extends AbstractBeanFac
|
||||
return cachedReturnType.resolve();
|
||||
}
|
||||
catch (LinkageError err) {
|
||||
// E.g. a NoClassDefFoundError for a generic method return type
|
||||
// For example, a NoClassDefFoundError for a generic method return type
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Failed to resolve type for factory method of bean '" + beanName + "': " +
|
||||
(uniqueCandidate != null ? uniqueCandidate : commonType), err);
|
||||
|
||||
@@ -1075,7 +1075,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess
|
||||
* Specify whether the configured initializer method is the default.
|
||||
* <p>The default value is {@code true} for a locally specified init method
|
||||
* but switched to {@code false} for a shared setting in a defaults section
|
||||
* (e.g. {@code bean init-method} versus {@code beans default-init-method}
|
||||
* (for example, {@code bean init-method} versus {@code beans default-init-method}
|
||||
* level in XML) which might not apply to all contained bean definitions.
|
||||
* @see #setInitMethodName
|
||||
* @see #applyDefaults
|
||||
@@ -1135,7 +1135,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess
|
||||
* Specify whether the configured destroy method is the default.
|
||||
* <p>The default value is {@code true} for a locally specified destroy method
|
||||
* but switched to {@code false} for a shared setting in a defaults section
|
||||
* (e.g. {@code bean destroy-method} versus {@code beans default-destroy-method}
|
||||
* (for example, {@code bean destroy-method} versus {@code beans default-destroy-method}
|
||||
* level in XML) which might not apply to all contained bean definitions.
|
||||
* @see #setDestroyMethodName
|
||||
* @see #applyDefaults
|
||||
@@ -1241,7 +1241,7 @@ public abstract class AbstractBeanDefinition extends BeanMetadataAttributeAccess
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the originating (e.g. decorated) BeanDefinition, if any.
|
||||
* Set the originating (for example, decorated) BeanDefinition, if any.
|
||||
*/
|
||||
public void setOriginatingBeanDefinition(BeanDefinition originatingBd) {
|
||||
this.resource = new BeanDefinitionResource(originatingBd);
|
||||
|
||||
@@ -147,7 +147,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp
|
||||
@Nullable
|
||||
private TypeConverter typeConverter;
|
||||
|
||||
/** String resolvers to apply e.g. to annotation attribute values. */
|
||||
/** String resolvers to apply, for example, to annotation attribute values. */
|
||||
private final List<StringValueResolver> embeddedValueResolvers = new CopyOnWriteArrayList<>();
|
||||
|
||||
/** BeanPostProcessors to apply. */
|
||||
@@ -1511,7 +1511,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp
|
||||
* Clear the merged bean definition cache, removing entries for beans
|
||||
* which are not considered eligible for full metadata caching yet.
|
||||
* <p>Typically triggered after changes to the original bean definitions,
|
||||
* e.g. after applying a {@code BeanFactoryPostProcessor}. Note that metadata
|
||||
* for example, after applying a {@code BeanFactoryPostProcessor}. Note that metadata
|
||||
* for beans which have already been created at this point will be kept around.
|
||||
* @since 4.2
|
||||
*/
|
||||
@@ -1570,7 +1570,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp
|
||||
|
||||
if (!ObjectUtils.isEmpty(typesToMatch)) {
|
||||
// When just doing type checks (i.e. not creating an actual instance yet),
|
||||
// use the specified temporary class loader (e.g. in a weaving scenario).
|
||||
// use the specified temporary class loader (for example, in a weaving scenario).
|
||||
ClassLoader tempClassLoader = getTempClassLoader();
|
||||
if (tempClassLoader != null) {
|
||||
dynamicLoader = tempClassLoader;
|
||||
|
||||
@@ -50,7 +50,7 @@ public interface AutowireCandidateResolver {
|
||||
* <p>The default implementation checks {@link DependencyDescriptor#isRequired()}.
|
||||
* @param descriptor the descriptor for the target method parameter or field
|
||||
* @return whether the descriptor is marked as required or possibly indicating
|
||||
* non-required status some other way (e.g. through a parameter annotation)
|
||||
* non-required status some other way (for example, through a parameter annotation)
|
||||
* @since 5.0
|
||||
* @see DependencyDescriptor#isRequired()
|
||||
*/
|
||||
|
||||
@@ -122,7 +122,7 @@ abstract class AutowireUtils {
|
||||
|
||||
/**
|
||||
* Resolve the given autowiring value against the given required type,
|
||||
* e.g. an {@link ObjectFactory} value to its actual object result.
|
||||
* for example, an {@link ObjectFactory} value to its actual object result.
|
||||
* @param autowiringValue the value to resolve
|
||||
* @param requiredType the type to assign the result to
|
||||
* @return the resolved value
|
||||
@@ -157,7 +157,7 @@ abstract class AutowireUtils {
|
||||
* the given {@code method} does not declare any {@linkplain
|
||||
* Method#getTypeParameters() formal type variables}</li>
|
||||
* <li>the {@linkplain Method#getReturnType() standard return type}, if the
|
||||
* target return type cannot be inferred (e.g., due to type erasure)</li>
|
||||
* target return type cannot be inferred (for example, due to type erasure)</li>
|
||||
* <li>{@code null}, if the length of the given arguments array is shorter
|
||||
* than the length of the {@linkplain
|
||||
* Method#getGenericParameterTypes() formal argument list} for the given
|
||||
@@ -182,8 +182,8 @@ abstract class AutowireUtils {
|
||||
Type[] methodParameterTypes = method.getGenericParameterTypes();
|
||||
Assert.isTrue(args.length == methodParameterTypes.length, "Argument array does not match parameter count");
|
||||
|
||||
// Ensure that the type variable (e.g., T) is declared directly on the method
|
||||
// itself (e.g., via <T>), not on the enclosing class or interface.
|
||||
// Ensure that the type variable (for example, T) is declared directly on the method
|
||||
// itself (for example, via <T>), not on the enclosing class or interface.
|
||||
boolean locallyDeclaredTypeVariableMatchesReturnType = false;
|
||||
for (TypeVariable<Method> currentTypeVariable : declaredTypeVariables) {
|
||||
if (currentTypeVariable.equals(genericReturnType)) {
|
||||
|
||||
@@ -918,7 +918,7 @@ class ConstructorResolver {
|
||||
catch (NoSuchBeanDefinitionException ex) {
|
||||
if (fallback) {
|
||||
// Single constructor or factory method -> let's return an empty array/collection
|
||||
// for e.g. a vararg or a non-null List/Set/Map parameter.
|
||||
// for example, a vararg or a non-null List/Set/Map parameter.
|
||||
if (paramType.isArray()) {
|
||||
return Array.newInstance(paramType.componentType(), 0);
|
||||
}
|
||||
@@ -1323,7 +1323,7 @@ class ConstructorResolver {
|
||||
// No public constructors -> check non-public
|
||||
ctors = clazz.getDeclaredConstructors();
|
||||
if (ctors.length == 1) {
|
||||
// A single non-public constructor, e.g. from a non-public record type
|
||||
// A single non-public constructor, for example, from a non-public record type
|
||||
return ctors;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -349,7 +349,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
this.dependencyComparator = otherListableFactory.dependencyComparator;
|
||||
// A clone of the AutowireCandidateResolver since it is potentially BeanFactoryAware
|
||||
setAutowireCandidateResolver(otherListableFactory.getAutowireCandidateResolver().cloneIfNecessary());
|
||||
// Make resolvable dependencies (e.g. ResourceLoader) available here as well
|
||||
// Make resolvable dependencies (for example, ResourceLoader) available here as well
|
||||
this.resolvableDependencies.putAll(otherListableFactory.resolvableDependencies);
|
||||
}
|
||||
}
|
||||
@@ -772,7 +772,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
}
|
||||
if (containsBeanDefinition(beanName)) {
|
||||
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
|
||||
// Check raw bean class, e.g. in case of a proxy.
|
||||
// Check raw bean class, for example, in case of a proxy.
|
||||
if (bd.hasBeanClass() && bd.getFactoryMethodName() == null) {
|
||||
Class<?> beanClass = bd.getBeanClass();
|
||||
if (beanClass != beanType) {
|
||||
@@ -811,7 +811,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
}
|
||||
if (containsBeanDefinition(beanName)) {
|
||||
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
|
||||
// Check raw bean class, e.g. in case of a proxy.
|
||||
// Check raw bean class, for example, in case of a proxy.
|
||||
if (bd.hasBeanClass() && bd.getFactoryMethodName() == null) {
|
||||
Class<?> beanClass = bd.getBeanClass();
|
||||
if (beanClass != beanType) {
|
||||
@@ -1211,7 +1211,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
|
||||
boolean explicitBeanOverride = (this.allowBeanDefinitionOverriding != null);
|
||||
if (existingDefinition.getRole() < beanDefinition.getRole()) {
|
||||
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
|
||||
// for example, was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Overriding user-defined bean definition for bean '" + beanName +
|
||||
"' with a framework-generated bean definition: replacing [" +
|
||||
@@ -1290,7 +1290,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
|
||||
// Remove corresponding bean from singleton cache, if any. Shouldn't usually
|
||||
// be necessary, rather just meant for overriding a context's default beans
|
||||
// (e.g. the default StaticMessageSource in a StaticApplicationContext).
|
||||
// (for example, the default StaticMessageSource in a StaticApplicationContext).
|
||||
destroySingleton(beanName);
|
||||
|
||||
// Remove a cached primary marker for the given bean.
|
||||
@@ -1521,7 +1521,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
|
||||
InjectionPoint previousInjectionPoint = ConstructorResolver.setCurrentInjectionPoint(descriptor);
|
||||
try {
|
||||
// Step 1: pre-resolved shortcut for single bean match, e.g. from @Autowired
|
||||
// Step 1: pre-resolved shortcut for single bean match, for example, from @Autowired
|
||||
Object shortcut = descriptor.resolveShortcut(this);
|
||||
if (shortcut != null) {
|
||||
return shortcut;
|
||||
@@ -1529,7 +1529,7 @@ public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFacto
|
||||
|
||||
Class<?> type = descriptor.getDependencyType();
|
||||
|
||||
// Step 2: pre-defined value or expression, e.g. from @Value
|
||||
// Step 2: pre-defined value or expression, for example, from @Value
|
||||
Object value = getAutowireCandidateResolver().getSuggestedValue(descriptor);
|
||||
if (value != null) {
|
||||
if (value instanceof String strValue) {
|
||||
|
||||
@@ -157,7 +157,7 @@ public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements
|
||||
/**
|
||||
* Add the given singleton factory for building the specified singleton
|
||||
* if necessary.
|
||||
* <p>To be called for early exposure purposes, e.g. to be able to
|
||||
* <p>To be called for early exposure purposes, for example, to be able to
|
||||
* resolve circular references.
|
||||
* @param beanName the name of the bean
|
||||
* @param singletonFactory the factory for the singleton object
|
||||
@@ -340,7 +340,7 @@ public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements
|
||||
|
||||
/**
|
||||
* Register an exception that happened to get suppressed during the creation of a
|
||||
* singleton bean instance, e.g. a temporary circular reference resolution problem.
|
||||
* singleton bean instance, for example, a temporary circular reference resolution problem.
|
||||
* <p>The default implementation preserves any given exception in this registry's
|
||||
* collection of suppressed exceptions, up to a limit of 100 exceptions, adding
|
||||
* them as related causes to an eventual top-level {@link BeanCreationException}.
|
||||
@@ -451,7 +451,7 @@ public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements
|
||||
|
||||
/**
|
||||
* Register a containment relationship between two beans,
|
||||
* e.g. between an inner bean and its containing outer bean.
|
||||
* for example, between an inner bean and its containing outer bean.
|
||||
* <p>Also registers the containing bean as dependent on the contained bean
|
||||
* in terms of destruction order.
|
||||
* @param containedBeanName the name of the contained (inner) bean
|
||||
|
||||
@@ -122,7 +122,7 @@ public abstract class FactoryBeanRegistrySupport extends DefaultSingletonBeanReg
|
||||
if (object == null) {
|
||||
object = doGetObjectFromFactoryBean(factory, beanName);
|
||||
// Only post-process and store if not put there already during getObject() call above
|
||||
// (e.g. because of circular reference processing triggered by custom getBean calls)
|
||||
// (for example, because of circular reference processing triggered by custom getBean calls)
|
||||
Object alreadyThere = this.factoryBeanObjectCache.get(beanName);
|
||||
if (alreadyThere != null) {
|
||||
object = alreadyThere;
|
||||
|
||||
@@ -27,7 +27,7 @@ import org.springframework.util.ObjectUtils;
|
||||
* parent bean definition can be flexibly configured through the "parentName" property.
|
||||
*
|
||||
* <p>In general, use this {@code GenericBeanDefinition} class for the purpose of
|
||||
* registering declarative bean definitions (e.g. XML definitions which a bean
|
||||
* registering declarative bean definitions (for example, XML definitions which a bean
|
||||
* post-processor might operate on, potentially even reconfiguring the parent name).
|
||||
* Use {@code RootBeanDefinition}/{@code ChildBeanDefinition} where parent/child
|
||||
* relationships happen to be pre-determined, and prefer {@link RootBeanDefinition}
|
||||
|
||||
@@ -33,7 +33,7 @@ import org.springframework.util.ClassUtils;
|
||||
/**
|
||||
* Basic {@link AutowireCandidateResolver} that performs a full generic type
|
||||
* match with the candidate's type if the dependency is declared as a generic type
|
||||
* (e.g. {@code Repository<Customer>}).
|
||||
* (for example, {@code Repository<Customer>}).
|
||||
*
|
||||
* <p>This is the base class for
|
||||
* {@link org.springframework.beans.factory.annotation.QualifierAnnotationAutowireCandidateResolver},
|
||||
@@ -147,7 +147,7 @@ public class GenericTypeAwareAutowireCandidateResolver extends SimpleAutowireCan
|
||||
}
|
||||
|
||||
if (descriptor.fallbackMatchAllowed()) {
|
||||
// Fallback matches allow unresolvable generics, e.g. plain HashMap to Map<String,String>;
|
||||
// Fallback matches allow unresolvable generics, for example, plain HashMap to Map<String,String>;
|
||||
// and pragmatically also java.util.Properties to any Map (since despite formally being a
|
||||
// Map<Object,Object>, java.util.Properties is usually perceived as a Map<String,String>).
|
||||
if (targetType.hasUnresolvableGenerics()) {
|
||||
|
||||
@@ -20,7 +20,7 @@ import org.springframework.beans.factory.FactoryBean;
|
||||
import org.springframework.lang.Nullable;
|
||||
|
||||
/**
|
||||
* Internal representation of a null bean instance, e.g. for a {@code null} value
|
||||
* Internal representation of a null bean instance, for example, for a {@code null} value
|
||||
* returned from {@link FactoryBean#getObject()} or from a factory method.
|
||||
*
|
||||
* <p>Each such null bean is represented by a dedicated {@code NullBean} instance
|
||||
|
||||
@@ -128,7 +128,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
|
||||
/**
|
||||
* Property suffix for references to other beans in the current
|
||||
* BeanFactory: e.g. {@code owner.dog(ref)=fido}.
|
||||
* BeanFactory: for example, {@code owner.dog(ref)=fido}.
|
||||
* Whether this is a reference to a singleton or a prototype
|
||||
* will depend on the definition of the target bean.
|
||||
*/
|
||||
@@ -165,7 +165,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
* Set the default parent bean for this bean factory.
|
||||
* If a child bean definition handled by this factory provides neither
|
||||
* a parent nor a class attribute, this default value gets used.
|
||||
* <p>Can be used e.g. for view definition files, to define a parent
|
||||
* <p>Can be used, for example, for view definition files, to define a parent
|
||||
* with a default view class and common attributes for all views.
|
||||
* View definitions that define their own parent or carry their own
|
||||
* class can still override this.
|
||||
@@ -219,7 +219,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
/**
|
||||
* Load bean definitions from the specified properties file.
|
||||
* @param resource the resource descriptor for the properties file
|
||||
* @param prefix a filter within the keys in the map: e.g. 'beans.'
|
||||
* @param prefix a filter within the keys in the map: for example, 'beans.'
|
||||
* (can be empty or {@code null})
|
||||
* @return the number of bean definitions found
|
||||
* @throws BeanDefinitionStoreException in case of loading or parsing errors
|
||||
@@ -243,7 +243,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
* Load bean definitions from the specified properties file.
|
||||
* @param encodedResource the resource descriptor for the properties file,
|
||||
* allowing to specify an encoding to use for parsing the file
|
||||
* @param prefix a filter within the keys in the map: e.g. 'beans.'
|
||||
* @param prefix a filter within the keys in the map: for example, 'beans.'
|
||||
* (can be empty or {@code null})
|
||||
* @return the number of bean definitions found
|
||||
* @throws BeanDefinitionStoreException in case of loading or parsing errors
|
||||
@@ -294,7 +294,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
* <p>Similar syntax as for a Map. This method is useful to enable
|
||||
* standard Java internationalization support.
|
||||
* @param rb the ResourceBundle to load from
|
||||
* @param prefix a filter within the keys in the map: e.g. 'beans.'
|
||||
* @param prefix a filter within the keys in the map: for example, 'beans.'
|
||||
* (can be empty or {@code null})
|
||||
* @return the number of bean definitions found
|
||||
* @throws BeanDefinitionStoreException in case of loading or parsing errors
|
||||
@@ -331,7 +331,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
* @param map a map of {@code name} to {@code property} (String or Object). Property
|
||||
* values will be strings if coming from a Properties file etc. Property names
|
||||
* (keys) <b>must</b> be Strings. Class keys must be Strings.
|
||||
* @param prefix a filter within the keys in the map: e.g. 'beans.'
|
||||
* @param prefix a filter within the keys in the map: for example, 'beans.'
|
||||
* (can be empty or {@code null})
|
||||
* @return the number of bean definitions found
|
||||
* @throws BeansException in case of loading or parsing errors
|
||||
@@ -346,7 +346,7 @@ public class PropertiesBeanDefinitionReader extends AbstractBeanDefinitionReader
|
||||
* @param map a map of {@code name} to {@code property} (String or Object). Property
|
||||
* values will be strings if coming from a Properties file etc. Property names
|
||||
* (keys) <b>must</b> be Strings. Class keys must be Strings.
|
||||
* @param prefix a filter within the keys in the map: e.g. 'beans.'
|
||||
* @param prefix a filter within the keys in the map: for example, 'beans.'
|
||||
* (can be empty or {@code null})
|
||||
* @param resourceDescription description of the resource that the
|
||||
* Map came from (for logging purposes)
|
||||
|
||||
@@ -266,7 +266,7 @@ public final class RegisteredBean {
|
||||
* Descriptor for how a bean should be instantiated. While the {@code targetClass}
|
||||
* is usually the declaring class of the {@code executable} (in case of a constructor
|
||||
* or a locally declared factory method), there are cases where retaining the actual
|
||||
* concrete class is necessary (e.g. for an inherited factory method).
|
||||
* concrete class is necessary (for example, for an inherited factory method).
|
||||
* @since 6.1.7
|
||||
* @param executable the {@link Executable} ({@link java.lang.reflect.Constructor}
|
||||
* or {@link java.lang.reflect.Method}) to invoke
|
||||
|
||||
@@ -37,18 +37,18 @@ import org.springframework.util.Assert;
|
||||
/**
|
||||
* A root bean definition represents the <b>merged bean definition at runtime</b>
|
||||
* that backs a specific bean in a Spring BeanFactory. It might have been created
|
||||
* from multiple original bean definitions that inherit from each other, e.g.
|
||||
* from multiple original bean definitions that inherit from each other, for example,
|
||||
* {@link GenericBeanDefinition GenericBeanDefinitions} from XML declarations.
|
||||
* A root bean definition is essentially the 'unified' bean definition view at runtime.
|
||||
*
|
||||
* <p>Root bean definitions may also be used for <b>registering individual bean
|
||||
* definitions in the configuration phase.</b> This is particularly applicable for
|
||||
* programmatic definitions derived from factory methods (e.g. {@code @Bean} methods)
|
||||
* and instance suppliers (e.g. lambda expressions) which come with extra type metadata
|
||||
* programmatic definitions derived from factory methods (for example, {@code @Bean} methods)
|
||||
* and instance suppliers (for example, lambda expressions) which come with extra type metadata
|
||||
* (see {@link #setTargetType(ResolvableType)}/{@link #setResolvedFactoryMethod(Method)}).
|
||||
*
|
||||
* <p>Note: The preferred choice for bean definitions derived from declarative sources
|
||||
* (e.g. XML definitions) is the flexible {@link GenericBeanDefinition} variant.
|
||||
* (for example, XML definitions) is the flexible {@link GenericBeanDefinition} variant.
|
||||
* GenericBeanDefinition comes with the advantage that it allows for dynamically
|
||||
* defining parent dependencies, not 'hard-coding' the role as a root bean definition,
|
||||
* even supporting parent relationship changes in the bean post-processor phase.
|
||||
|
||||
@@ -20,7 +20,7 @@ import org.springframework.beans.factory.BeanCreationException;
|
||||
|
||||
/**
|
||||
* A subclass of {@link BeanCreationException} which indicates that the target scope
|
||||
* is not active, e.g. in case of request or session scope.
|
||||
* is not active, for example, in case of request or session scope.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
* @since 5.3
|
||||
|
||||
@@ -213,7 +213,7 @@ public class DefaultBeanDefinitionDocumentReader implements BeanDefinitionDocume
|
||||
return;
|
||||
}
|
||||
|
||||
// Resolve system properties: e.g. "${user.dir}"
|
||||
// Resolve system properties: for example, "${user.dir}"
|
||||
location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location);
|
||||
|
||||
Set<Resource> actualResources = new LinkedHashSet<>(4);
|
||||
|
||||
@@ -30,7 +30,7 @@ import org.springframework.util.StringUtils;
|
||||
* {@link org.springframework.beans.BeanWrapperImpl} will register this
|
||||
* editor by default.
|
||||
*
|
||||
* <p>Also supports conversion from a Unicode character sequence; e.g.
|
||||
* <p>Also supports conversion from a Unicode character sequence; for example,
|
||||
* {@code u0041} ('A').
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
|
||||
@@ -26,7 +26,7 @@ import org.springframework.util.StringUtils;
|
||||
* String representations into Charset objects and back.
|
||||
*
|
||||
* <p>Expects the same syntax as Charset's {@link java.nio.charset.Charset#name()},
|
||||
* e.g. {@code UTF-8}, {@code ISO-8859-16}, etc.
|
||||
* for example, {@code UTF-8}, {@code ISO-8859-16}, etc.
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @author Sam Brannen
|
||||
|
||||
@@ -27,7 +27,7 @@ import org.springframework.util.Assert;
|
||||
/**
|
||||
* One-way PropertyEditor which can convert from a text String to a
|
||||
* {@code java.io.InputStream}, interpreting the given String as a
|
||||
* Spring resource location (e.g. a URL String).
|
||||
* Spring resource location (for example, a URL String).
|
||||
*
|
||||
* <p>Supports Spring-style URL notation: any fully qualified standard URL
|
||||
* ("file:", "http:", etc.) and Spring's special "classpath:" pseudo-URL.
|
||||
|
||||
@@ -24,7 +24,7 @@ import org.springframework.util.StringUtils;
|
||||
* Editor for {@code java.util.Locale}, to directly populate a Locale property.
|
||||
*
|
||||
* <p>Expects the same syntax as Locale's {@code toString()}, i.e. language +
|
||||
* optionally country + optionally variant, separated by "_" (e.g. "en", "en_US").
|
||||
* optionally country + optionally variant, separated by "_" (for example, "en", "en_US").
|
||||
* Also accepts spaces as separators, as an alternative to underscores.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.springframework.util.Assert;
|
||||
/**
|
||||
* One-way PropertyEditor which can convert from a text String to a
|
||||
* {@code java.io.Reader}, interpreting the given String as a Spring
|
||||
* resource location (e.g. a URL String).
|
||||
* resource location (for example, a URL String).
|
||||
*
|
||||
* <p>Supports Spring-style URL notation: any fully qualified standard URL
|
||||
* ("file:", "http:", etc.) and Spring's special "classpath:" pseudo-URL.
|
||||
|
||||
@@ -97,7 +97,7 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport {
|
||||
* @param separator the separator to use for splitting a {@link String}
|
||||
* @param charsToDelete a set of characters to delete, in addition to
|
||||
* trimming an input String. Useful for deleting unwanted line breaks:
|
||||
* e.g. "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* for example, "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* @param emptyArrayAsNull {@code true} if an empty String array
|
||||
* is to be transformed into {@code null}
|
||||
*/
|
||||
@@ -110,7 +110,7 @@ public class StringArrayPropertyEditor extends PropertyEditorSupport {
|
||||
* @param separator the separator to use for splitting a {@link String}
|
||||
* @param charsToDelete a set of characters to delete, in addition to
|
||||
* trimming an input String. Useful for deleting unwanted line breaks:
|
||||
* e.g. "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* for example, "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* @param emptyArrayAsNull {@code true} if an empty String array
|
||||
* is to be transformed into {@code null}
|
||||
* @param trimValues {@code true} if the values in the parsed arrays
|
||||
|
||||
@@ -25,7 +25,7 @@ import org.springframework.util.StringUtils;
|
||||
* Property editor that trims Strings.
|
||||
*
|
||||
* <p>Optionally allows transforming an empty string into a {@code null} value.
|
||||
* Needs to be explicitly registered, e.g. for command binding.
|
||||
* Needs to be explicitly registered, for example, for command binding.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
* @see org.springframework.validation.DataBinder#registerCustomEditor
|
||||
@@ -52,7 +52,7 @@ public class StringTrimmerEditor extends PropertyEditorSupport {
|
||||
* Create a new StringTrimmerEditor.
|
||||
* @param charsToDelete a set of characters to delete, in addition to
|
||||
* trimming an input String. Useful for deleting unwanted line breaks:
|
||||
* e.g. "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* for example, "\r\n\f" will delete all new lines and line feeds in a String.
|
||||
* @param emptyAsNull {@code true} if an empty String is to be
|
||||
* transformed into {@code null}
|
||||
*/
|
||||
|
||||
@@ -343,14 +343,14 @@
|
||||
<!--
|
||||
The constructor-arg tag can have an optional index attribute,
|
||||
to specify the exact index in the constructor argument list. Only needed
|
||||
to avoid ambiguities, e.g. in case of 2 arguments of the same type.
|
||||
to avoid ambiguities, for example, in case of 2 arguments of the same type.
|
||||
-->
|
||||
<!ATTLIST constructor-arg index CDATA #IMPLIED>
|
||||
|
||||
<!--
|
||||
The constructor-arg tag can have an optional type attribute,
|
||||
to specify the exact type of the constructor argument. Only needed
|
||||
to avoid ambiguities, e.g. in case of 2 single argument constructors
|
||||
to avoid ambiguities, for example, in case of 2 single argument constructors
|
||||
that can both be converted from a String.
|
||||
-->
|
||||
<!ATTLIST constructor-arg type CDATA #IMPLIED>
|
||||
|
||||
@@ -90,7 +90,7 @@
|
||||
elements followed, etc. If none of the specified profiles are active at time of
|
||||
parsing, then the entire element and its contents will be ignored.
|
||||
|
||||
If a profile is prefixed with the NOT operator '!', e.g.
|
||||
If a profile is prefixed with the NOT operator '!', for example,
|
||||
|
||||
<beans profile="p1,!p2">
|
||||
|
||||
@@ -152,8 +152,8 @@
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
A default bean name pattern for identifying autowire candidates:
|
||||
e.g. "*Service", "data*", "*Service*", "data*Service".
|
||||
Also accepts a comma-separated list of patterns: e.g. "*Service,*Dao".
|
||||
for example, "*Service", "data*", "*Service*", "data*Service".
|
||||
Also accepts a comma-separated list of patterns: for example, "*Service,*Dao".
|
||||
See the documentation for the 'autowire-candidate' attribute of the
|
||||
'bean' element for the semantic details of autowire candidate beans.
|
||||
]]></xsd:documentation>
|
||||
@@ -308,7 +308,7 @@
|
||||
|
||||
Singletons are most commonly used, and are ideal for multi-threaded
|
||||
service objects. Further scopes, such as "request" or "session", might
|
||||
be supported by extended bean factories (e.g. in a web environment).
|
||||
be supported by extended bean factories (for example, in a web environment).
|
||||
|
||||
Inner bean definitions inherit the scope of their containing bean
|
||||
definition, unless explicitly specified: The inner bean will be a
|
||||
@@ -341,7 +341,7 @@
|
||||
Hence, it needs to be specified per concrete bean definition. It can be
|
||||
shared through the 'default-lazy-init' attribute at the 'beans' level
|
||||
and potentially inherited from outer 'beans' defaults in case of nested
|
||||
'beans' sections (e.g. with different profiles).
|
||||
'beans' sections (for example, with different profiles).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
@@ -389,7 +389,7 @@
|
||||
Hence, it needs to be specified per concrete bean definition. It can be
|
||||
shared through the 'default-autowire' attribute at the 'beans' level
|
||||
and potentially inherited from outer 'beans' defaults in case of nested
|
||||
'beans' sections (e.g. with different profiles).
|
||||
'beans' sections (for example, with different profiles).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:simpleType>
|
||||
@@ -595,7 +595,7 @@
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
The exact index of the argument in the constructor argument list.
|
||||
Only needed to avoid ambiguities, e.g. in case of 2 arguments of
|
||||
Only needed to avoid ambiguities, for example, in case of 2 arguments of
|
||||
the exact same type.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
@@ -604,7 +604,7 @@
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
The exact type of the constructor argument. Only needed to avoid
|
||||
ambiguities, e.g. in case of 2 single argument constructors
|
||||
ambiguities, for example, in case of 2 single argument constructors
|
||||
that can both be converted from a String.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
@@ -613,7 +613,7 @@
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
The exact name of the argument in the constructor argument list.
|
||||
Only needed to avoid ambiguities, e.g. in case of 2 arguments of
|
||||
Only needed to avoid ambiguities, for example, in case of 2 arguments of
|
||||
the exact same type. Note: This requires debug symbols to be
|
||||
stored in the class file in order to introspect argument names!
|
||||
]]></xsd:documentation>
|
||||
@@ -899,7 +899,7 @@
|
||||
<xsd:documentation><![CDATA[
|
||||
An array can contain multiple inner bean, ref, collection, or value elements.
|
||||
This configuration element will always result in an array, even when being
|
||||
defined e.g. as a value for a map with value type Object.
|
||||
defined, for example, as a value for a map with value type Object.
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:complexType>
|
||||
|
||||
@@ -104,7 +104,7 @@
|
||||
<xsd:attribute name="name" type="xsd:string" use="required">
|
||||
<xsd:annotation>
|
||||
<xsd:documentation><![CDATA[
|
||||
Defines the name of a custom bean scope that the annotated type registers, e.g. "conversation".
|
||||
Defines the name of a custom bean scope that the annotated type registers, for example, "conversation".
|
||||
Such a scope will be available in addition to the standard "singleton" and "prototype" scopes
|
||||
(plus "request", "session" and "globalSession" in a web application environment).
|
||||
]]></xsd:documentation>
|
||||
|
||||
@@ -69,7 +69,7 @@
|
||||
which will be returned by all calls to getBean with the given id), or
|
||||
"prototype" (independent instance resulting from each call to getBean).
|
||||
Default is "singleton". Further scopes, such as "request" or "session",
|
||||
might be supported by extended bean factories (e.g. in a web environment).
|
||||
might be supported by extended bean factories (for example, in a web environment).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
@@ -110,7 +110,7 @@
|
||||
which will be returned by all calls to getBean with the given id), or
|
||||
"prototype" (independent instance resulting from each call to getBean).
|
||||
Default is "singleton". Further scopes, such as "request" or "session",
|
||||
might be supported by extended bean factories (e.g. in a web environment).
|
||||
might be supported by extended bean factories (for example, in a web environment).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
@@ -151,7 +151,7 @@
|
||||
which will be returned by all calls to getBean with the given id), or
|
||||
"prototype" (independent instance resulting from each call to getBean).
|
||||
Default is "singleton". Further scopes, such as "request" or "session",
|
||||
might be supported by extended bean factories (e.g. in a web environment).
|
||||
might be supported by extended bean factories (for example, in a web environment).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
@@ -209,7 +209,7 @@
|
||||
which will be returned by all calls to getBean with the given id), or
|
||||
"prototype" (independent instance resulting from each call to getBean).
|
||||
Default is "singleton". Further scopes, such as "request" or "session",
|
||||
might be supported by extended bean factories (e.g. in a web environment).
|
||||
might be supported by extended bean factories (for example, in a web environment).
|
||||
]]></xsd:documentation>
|
||||
</xsd:annotation>
|
||||
</xsd:attribute>
|
||||
|
||||
Reference in New Issue
Block a user