From f1c062fe9e2b959981a9bd993dd0e05ea590a82a Mon Sep 17 00:00:00 2001 From: Chin Huang Date: Sat, 12 May 2012 00:53:51 -0400 Subject: [PATCH] Fix typos in Reference Documentation --- src/reference/docbook/aop.xml | 2 +- .../docbook/beans-classpath-scanning.xml | 2 +- src/reference/docbook/beans.xml | 2 +- src/reference/docbook/cache.xml | 12 ++++++------ src/reference/docbook/classic-aop-spring.xml | 2 +- src/reference/docbook/expressions.xml | 2 +- src/reference/docbook/jdbc.xml | 16 ++++++++-------- src/reference/docbook/mvc.xml | 8 ++++---- src/reference/docbook/new-in-3.1.xml | 2 +- src/reference/docbook/overview.xml | 10 +++++----- src/reference/docbook/portlet.xml | 2 +- src/reference/docbook/remoting.xml | 2 +- src/reference/docbook/resources.xml | 2 +- src/reference/docbook/scheduling.xml | 2 +- src/reference/docbook/validation.xml | 18 +++++++++--------- src/reference/docbook/web-integration.xml | 2 +- src/reference/docbook/xml-custom.xml | 2 +- src/reference/docbook/xsd-configuration.xml | 4 ++-- 18 files changed, 46 insertions(+), 46 deletions(-) diff --git a/src/reference/docbook/aop.xml b/src/reference/docbook/aop.xml index a5e7101114d..dd619187967 100644 --- a/src/reference/docbook/aop.xml +++ b/src/reference/docbook/aop.xml @@ -2545,7 +2545,7 @@ public @interface Idempotent { final methods cannot be advised, as they - cannot be overriden. + cannot be overridden. diff --git a/src/reference/docbook/beans-classpath-scanning.xml b/src/reference/docbook/beans-classpath-scanning.xml index 3baafde5d7f..ac61cfc3e99 100644 --- a/src/reference/docbook/beans-classpath-scanning.xml +++ b/src/reference/docbook/beans-classpath-scanning.xml @@ -144,7 +144,7 @@ public class JpaMovieFinder implements MovieFinder { In Spring 3.0 RC1 you can use JSR 330's @Named annotation in place of - stereotpye annotations and they will be automatically detected during + stereotype annotations and they will be automatically detected during component-scanning. The value of the @Named property will be used as the Bean Name. At this time Spring defaults for bean scope will be applied diff --git a/src/reference/docbook/beans.xml b/src/reference/docbook/beans.xml index 16154a98ec6..c2c4425b961 100644 --- a/src/reference/docbook/beans.xml +++ b/src/reference/docbook/beans.xml @@ -224,7 +224,7 @@ The footnote should x-ref to first section in that chapter but I can't find the After you learn about Spring's IoC container, you may want to know more about Spring's Resource abstraction, as described in , which - provides a convenient mechanism for reading an InputSream from + provides a convenient mechanism for reading an InputStream from locations defined in a URI syntax. In particular, Resource paths are used to construct applications contexts as described in In fact, depending on the JVM implementation or running conditions, the same hashCode can be reused for different objects, in the same VM instance. To provide a different default key generator, one needs to implement the org.springframework.cache.KeyGenerator interface. - Once configured, the generator will be used for each declaration that doesn not specify its own key generation strategy (see below). + Once configured, the generator will be used for each declaration that does not specify its own key generation strategy (see below). @@ -223,11 +223,11 @@ public Book findBook(String name)]]>
<literal>@CachePut</literal> annotation - For cases where the cache needs to be updated without interferring with the method execution, one can use the @CachePut annotation. That is, the method will always + For cases where the cache needs to be updated without interfering with the method execution, one can use the @CachePut annotation. That is, the method will always be executed and its result placed into the cache (according to the @CachePut options). It supports the same options as @Cacheable and should be used for cache population rather then method flow optimization. - Note that using @CachePut and @Cacheable annotations on the same method is generaly discouraged because they have different behaviours. While the latter + Note that using @CachePut and @Cacheable annotations on the same method is generally discouraged because they have different behaviours. While the latter causes the method execution to be skipped by using the cache, the former forces the execution in order to execute a cache update. This leads to unexpected behaviour and with the exception of specific corner-cases (such as annotations having conditions that exclude them from each other), such declarations should be avoided.
@@ -447,7 +447,7 @@ public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)]]>< public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)]]> Even though @SlowService is not a Spring annotation, the container automatically picks up its declaration at runtime and understands its meaning. Note that as - mentined above, the annotation-driven behaviour needs to be enabled. + mentioned above, the annotation-driven behaviour needs to be enabled. @@ -488,7 +488,7 @@ public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)]]>< The declarative XML caching supports all of the annotation-based model so moving between the two should be fairly easy - further more both can be used inside the same application. The XML based approach does not touch the target code however it is inherently more verbose; when dealing with classes with overloaded methods that are targeted for caching, identifying the proper methods does take an extra effort since the method argument is not a good discriminator - in these cases, the AspectJ pointcut can be used to cherry pick the target - methods and apply the appropriate caching functionality. Howeve through XML, it is easier to apply a package/group/interface-wide caching (again due to the AspectJ poincut) and to create + methods and apply the appropriate caching functionality. However through XML, it is easier to apply a package/group/interface-wide caching (again due to the AspectJ pointcut) and to create template-like definitions (as we did in the example above by defining the target cache through the cache:definitions cache attribute). @@ -554,7 +554,7 @@ public Book findBook(ISBN isbn, boolean checkWarehouse, boolean includeUsed)]]>< ]]> - The CompositeCacheManager above chains multiple CacheManagers and aditionally, through the addNoOpManager flag, adds a + The CompositeCacheManager above chains multiple CacheManagers and additionally, through the addNoOpManager flag, adds a no op cache that for all the definitions not handled by the configured cache managers. That is, every cache definition not found in either jdkCache or gemfireCache (configured above) will be handled by the no op cache, which will not store any information causing the target method to be executed every time. diff --git a/src/reference/docbook/classic-aop-spring.xml b/src/reference/docbook/classic-aop-spring.xml index f770d464d73..94229c7761b 100644 --- a/src/reference/docbook/classic-aop-spring.xml +++ b/src/reference/docbook/classic-aop-spring.xml @@ -1808,7 +1808,7 @@ Object oldTarget = swapper.swap(newTarget); Note that the target object - "businessObjectTarget" in the example - must be a prototype. This allows the PoolingTargetSource implementation to create new - instances of the target to grow the pool as necessary. See the havadoc + instances of the target to grow the pool as necessary. See the Javadoc for AbstractPoolingTargetSource and the concrete subclass you wish to use for information about its properties: "maxSize" is the most basic, and always guaranteed to be present. diff --git a/src/reference/docbook/expressions.xml b/src/reference/docbook/expressions.xml index a1df39b5704..4a2ff221ce0 100644 --- a/src/reference/docbook/expressions.xml +++ b/src/reference/docbook/expressions.xml @@ -688,7 +688,7 @@ boolean trueValue = parser.parseExpression(expression).getValue(societyContext, boolean trueValue = parser.parseExpression("true or false").getValue(Boolean.class); // evaluates to true -String expression = "isMember('Nikola Tesla') or isMember('Albert Einstien')"; +String expression = "isMember('Nikola Tesla') or isMember('Albert Einstein')"; boolean trueValue = parser.parseExpression(expression).getValue(societyContext, Boolean.class); // -- NOT -- diff --git a/src/reference/docbook/jdbc.xml b/src/reference/docbook/jdbc.xml index 74524e03d9c..57985de6538 100644 --- a/src/reference/docbook/jdbc.xml +++ b/src/reference/docbook/jdbc.xml @@ -736,7 +736,7 @@ public Actor findActor(String specialty, int age) { }; - // notice the wrapping up of the argumenta in an array + // notice the wrapping up of the arguments in an array return (Actor) jdbcTemplate.queryForObject(sql, new Object[] {specialty, age}, mapper); } @@ -813,7 +813,7 @@ public Actor findActor(String specialty, int age) { class="libraryfile">sql-error-codes.xml. This file is populated with vendor codes and based on the DatabaseProductName taken from the - DatabaseMetaData. The codes for the acual + DatabaseMetaData. The codes for the actual database you are using are used. The SQLErrorCodeSQLExceptionTranslator @@ -888,7 +888,7 @@ public Actor findActor(String specialty, int age) { processing where this translator is needed. Here is an example of how this custom translator can be used: - private JdbcTemplate jdbcTemoplate; + private JdbcTemplate jdbcTemplate; public void setDataSource(DataSource dataSource) { // create a JdbcTemplate and set data source @@ -901,7 +901,7 @@ public void setDataSource(DataSource dataSource) { } public void updateShippingCharge(long orderId, long pct) { - // use the prepared JdbcTemplate for this update + // use the prepared JdbcTemplate for this update this.jdbcTemplate.update( "update orders" + " set shipping_charge = shipping_charge * ? / 100" + @@ -1547,8 +1547,8 @@ dataSource.setPassword(""); length indicates the number of updates in that batch. The number of updates in each batch should be the the batch size provided for all batches except for the last one that might be less, depending on the - total number of updat objects provided. The update count for each update - stament is the one reported by the JDBC driver. If the count is not + total number of update objects provided. The update count for each update + statement is the one reported by the JDBC driver. If the count is not available, the JDBC driver returns a -2 value. @@ -2501,7 +2501,7 @@ public class TitlesAfterDateStoredProcedure extends StoredProcedure { Many update and query methods of the JdbcTemplate take an additional parameter in the form of an int array. This array is used to - indicate the SQL type of the coresponding parameter using constant + indicate the SQL type of the corresponding parameter using constant values from the java.sql.Types class. Provide one entry for each parameter. @@ -2983,7 +2983,7 @@ public class DataAccessUnitTestTemplate { <jdbc:script location="..."/> </jdbc:initialize-database>In this example we are saying we expect that sometimes the scripts will be run against an empty - dtabase and there are some DROP statements in the scripts which would + database and there are some DROP statements in the scripts which would therefore fail. So failed SQL DROP statements will be ignored, but other failures will cause an exception. This is useful if your SQL dialect doesn't support DROP ... IF EXISTS (or diff --git a/src/reference/docbook/mvc.xml b/src/reference/docbook/mvc.xml index 59051321828..80b8ae89b39 100644 --- a/src/reference/docbook/mvc.xml +++ b/src/reference/docbook/mvc.xml @@ -269,7 +269,7 @@ </web-app> - In the preceding example, all requests startig with + In the preceding example, all requests starting with /example will be handled by the DispatcherServlet instance named example. This is only the first step in setting up @@ -1073,7 +1073,7 @@ public void addPet(@RequestBody Pet pet, Model model) { The consumes condition is supported on the type and on the method level. Unlike most other conditions, when used at the type level, method-level consumable types override - rather than extend type-level consumeable types. + rather than extend type-level consumable types. @@ -1116,7 +1116,7 @@ public Pet getPet(@PathVariable String petId, Model model) { You can narrow request matching through request parameter conditions such as "myParam", "!myParam", or "myParam=myValue". The first two test for request - parameter presense/absence and the third for a specific parameter + parameter presence/absence and the third for a specific parameter value. Here is an example with a request parameter value condition: @@ -4581,7 +4581,7 @@ public class WebConfig extends WebMvcConfigurerAdapter { DefaultServletHttpRequestHandler will attempt to auto-detect the default Servlet for the container at startup time, using a list of known names for most of the major Servlet containers - (including Tomcat, Jetty, Glassfish, JBoss, Resin, WebLogic, and + (including Tomcat, Jetty, GlassFish, JBoss, Resin, WebLogic, and WebSphere). If the default Servlet has been custom configured with a different name, or if a different Servlet container is being used where the default Servlet name is unknown, then the default Servlet's name diff --git a/src/reference/docbook/new-in-3.1.xml b/src/reference/docbook/new-in-3.1.xml index 3f0ff34b07a..ea2c597fc8e 100644 --- a/src/reference/docbook/new-in-3.1.xml +++ b/src/reference/docbook/new-in-3.1.xml @@ -490,7 +490,7 @@ A new UriComponents class has been added, which is an immutable container of URI components providing access to all contained URI components. - A nenw UriComponentsBuilder class is also + A new UriComponentsBuilder class is also provided to help create UriComponents instances. Together the two classes give fine-grained control over all aspects of preparing a URI including construction, expansion diff --git a/src/reference/docbook/overview.xml b/src/reference/docbook/overview.xml index e5db12efb31..87451fe0d56 100644 --- a/src/reference/docbook/overview.xml +++ b/src/reference/docbook/overview.xml @@ -427,7 +427,7 @@ TR: OK. Added to diagram.--> development snapshots and milestone releases (a copy of the final releases is also held here). The jar file names are in the same form as Maven Central, so this is a useful place to get - development versions of Spring to use with other libraries depoyed + development versions of Spring to use with other libraries deployed in Maven Central. @@ -615,7 +615,7 @@ TR: OK. Added to diagram.--> We used the Maven Central naming conventions in the example above, so that works with Maven Central or the SpringSource S3 Maven repository. To use the S3 Maven repository (e.g. for milestones or - developer snaphots), you need to specify the repository location in + developer snapshots), you need to specify the repository location in your Maven configuration. For full releases: <repositories> @@ -670,7 +670,7 @@ TR: OK. Added to diagram.--> </repositories> If you are managing your dependencies by hand, the URL in the - repository declaration above is not browseable, but there is a user + repository declaration above is not browsable, but there is a user interface at http://www.springsource.com/repository that can be used to search for and download dependencies. It also has @@ -879,8 +879,8 @@ TR: OK. Added to diagram.--> and generates fewer dependencies, is to bind directly to Logback. This removes the extra binding step because Logback implements SLF4J directly, so you only need - to depend on two libaries not four (jcl-over-slf4j and - logback). If you do that you might also need to exlude the + to depend on two libraries not four (jcl-over-slf4j and + logback). If you do that you might also need to exclude the slf4j-api dependency from other external dependencies (not Spring), because you only want one version of that API on the classpath. diff --git a/src/reference/docbook/portlet.xml b/src/reference/docbook/portlet.xml index 5a71478ee4c..538b9dca798 100644 --- a/src/reference/docbook/portlet.xml +++ b/src/reference/docbook/portlet.xml @@ -518,7 +518,7 @@ included here for completeness. When using the AbstractController as a - baseclass for your controllers (which is not recommended since there + base class for your controllers (which is not recommended since there are a lot of other controllers that might already do the job for you) you only have to override either the handleActionRequestInternal(ActionRequest, diff --git a/src/reference/docbook/remoting.xml b/src/reference/docbook/remoting.xml index 006dd621371..d14151c71ab 100644 --- a/src/reference/docbook/remoting.xml +++ b/src/reference/docbook/remoting.xml @@ -1473,7 +1473,7 @@ URI location = template.postForLocation(uri, booking, "1"); URI uri = uriComponents.toUri(); - Or specify each URI component indiviudally: + Or specify each URI component individually: UriComponents uriComponents = UriComponentsBuilder.newInstance() diff --git a/src/reference/docbook/resources.xml b/src/reference/docbook/resources.xml index a25e74b93e7..9d0ce92791c 100644 --- a/src/reference/docbook/resources.xml +++ b/src/reference/docbook/resources.xml @@ -651,7 +651,7 @@ case, the resolution strategy is fairly simple: a ClassLoader.getResources() call is used on the last non-wildcard path segment to get all the matching resources in the class loader - hierarchy, and then off each resource the same PathMatcher resoltion + hierarchy, and then off each resource the same PathMatcher resolution strategy described above is used for the wildcard subpath. diff --git a/src/reference/docbook/scheduling.xml b/src/reference/docbook/scheduling.xml index e85fa791125..e6a360d1e48 100644 --- a/src/reference/docbook/scheduling.xml +++ b/src/reference/docbook/scheduling.xml @@ -592,7 +592,7 @@ Future<String> returnSomething(int i) { @Async can not be used in conjunction with lifecycle callbacks such as - @PostConstruct. To asynchonously + @PostConstruct. To asynchronously initialize Spring beans you currently have to use a separate initializing Spring bean that invokes the @Async annotated method on the target diff --git a/src/reference/docbook/validation.xml b/src/reference/docbook/validation.xml index f6a0c5177d6..43a6b43ccc4 100644 --- a/src/reference/docbook/validation.xml +++ b/src/reference/docbook/validation.xml @@ -1085,7 +1085,7 @@ public interface ConversionService { A default ConversionService can convert between strings, numbers, - enums, collections, maps, and other common types. To suppliment or + enums, collections, maps, and other common types. To supplement or override the default converters with your own custom converter(s), set the converters property. Property values may implement either of the Converter, ConverterFactory, or GenericConverter @@ -1112,9 +1112,9 @@ public interface ConversionService {
- Using a ConversionService programatically + Using a ConversionService programmatically - To work with a ConversionService instance programatically, simply + To work with a ConversionService instance programmatically, simply inject a reference to it like you would for any other bean: { The FormatterRegistry is an SPI for registering formatters and converters. FormattingConversionService is an implementation of FormatterRegistry suitable for most environments. - This implementation may be configured programatically or declaratively + This implementation may be configured programmatically or declaratively as a Spring bean using FormattingConversionServiceFactoryBean. - Because this implemementation also implements + Because this implementation also implements ConversionService, it can be directly configured for use with Spring's DataBinder and the Spring Expression Language (SpEL). @@ -1419,7 +1419,7 @@ public interface FormatterRegistrar { Configuring Formatting in Spring MVC In a Spring MVC application, you may configure a custom - ConversionService instance explicity as an attribute of the + ConversionService instance explicitly as an attribute of the annotation-driven element of the MVC namespace. This ConversionService will then be used anytime a type conversion is required during Controller model binding. If not configured explicitly, @@ -1443,7 +1443,7 @@ public interface FormatterRegistrar { ]]> - With this one-line of configuation, default formatters for Numbers + With this one-line of configuration, default formatters for Numbers and Date types will be installed, including support for the @NumberFormat and @DateTimeFormat annotations. Full support for the Joda Time formatting library is also installed if Joda Time is present on the @@ -1503,7 +1503,7 @@ public interface FormatterRegistrar { Spring 3 introduces several enhancements to its validation support. First, the JSR-303 Bean Validation API is now fully supported. Second, - when used programatically, Spring's DataBinder can now validate objects as + when used programmatically, Spring's DataBinder can now validate objects as well as bind to them. Third, Spring MVC now has support for declaratively validating @Controller inputs. @@ -1671,7 +1671,7 @@ public class MyConstraintValidator implements ConstraintValidator { binder.validate(). Any validation Errors are automatically added to the binder's BindingResult. - When working with the DataBinder programatically, this can be used + When working with the DataBinder programmatically, this can be used to invoke validation logic after binding to a target object: Foo target = new Foo(); diff --git a/src/reference/docbook/web-integration.xml b/src/reference/docbook/web-integration.xml index fda197ddb1d..2fdacade5e4 100644 --- a/src/reference/docbook/web-integration.xml +++ b/src/reference/docbook/web-integration.xml @@ -624,7 +624,7 @@ - A very succesful design pattern in Tapestry is to keep pages + A very successful design pattern in Tapestry is to keep pages and components very simple, and delegate as much logic as possible out to HiveMind [or Spring, or whatever] services. Listener methods should diff --git a/src/reference/docbook/xml-custom.xml b/src/reference/docbook/xml-custom.xml index 3d2c36f200d..2c52c8d3e2c 100644 --- a/src/reference/docbook/xml-custom.xml +++ b/src/reference/docbook/xml-custom.xml @@ -225,7 +225,7 @@ public class SimpleDateFormatBeanDefinitionParser extends AbstractSingleBeanDefi properties files. These properties files are both placed in a 'META-INF' directory in your application, and can, for example, be distributed alongside your binary classes in a JAR file. The Spring XML parsing - infrastructurewill automatically pick up your new extension by consuming these special + infrastructure will automatically pick up your new extension by consuming these special properties files, the formats of which are detailed below.
<filename>'META-INF/spring.handlers'</filename> diff --git a/src/reference/docbook/xsd-configuration.xml b/src/reference/docbook/xsd-configuration.xml index 71c34aef80f..62cd9fceb48 100644 --- a/src/reference/docbook/xsd-configuration.xml +++ b/src/reference/docbook/xsd-configuration.xml @@ -125,7 +125,7 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem implementation, the FieldRetrievingFactoryBean, to set the value of the 'isolation' property on a bean to the value of the 'java.sql.Connection.TRANSACTION_SERIALIZABLE' - constant. This is all well and good, but it is a tad verbose and (unneccessarily) + constant. This is all well and good, but it is a tad verbose and (unnecessarily) exposes Spring's internal plumbing to the end user. The following XML Schema-based version is more concise @@ -771,7 +771,7 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem @Resource (if available), and JPA's @PersistenceContext and @PersistenceUnit (if available). Alternatively, you can choose to activate the individual - BeanPostProcessors for those annotations explictly. + BeanPostProcessors for those annotations explicitly. This element does not activate processing of Spring's @Transactional