diff --git a/spring-framework-reference/src/xsd-configuration.xml b/spring-framework-reference/src/xsd-configuration.xml index 2d5e05b9127..2f126f953f7 100644 --- a/spring-framework-reference/src/xsd-configuration.xml +++ b/spring-framework-reference/src/xsd-configuration.xml @@ -114,7 +114,7 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem ]]>
<literal><util:constant/></literal> - Before... + Before... Setting a bean property or constructor arg from a field value - FieldRetrievingFactoryBean - is a FactoryBean which retrieves a - static or non-static field value. It is typically - used for retrieving public static - final constants, which may then be used to set a - property value or constructor arg for another bean. - + FieldRetrievingFactoryBean + is a FactoryBean which retrieves a + static or non-static field value. It is typically + used for retrieving public static + final constants, which may then be used to set a + property value or constructor arg for another bean. + - Find below an example which shows how a static field is exposed, by - using the staticField - property: - + Find below an example which shows how a static field is exposed, by + using the staticField + property: + @@ -161,12 +161,12 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem ]]> - This does mean that there is no longer any choice in what the bean id is (so - any other bean that refers to it will also have to use this longer name), - but this form is very concise to define, and very convenient to use as an - inner bean since the id doesn't have to be specified for the bean - reference: - + This does mean that there is no longer any choice in what the bean id is (so + any other bean that refers to it will also have to use this longer name), + but this form is very concise to define, and very convenient to use as an + inner bean since the id doesn't have to be specified for the bean + reference: + ]]> - It is also possible to access a non-static (instance) field of another bean, - as described in the API documentation for the - FieldRetrievingFactoryBean - class. - + It is also possible to access a non-static (instance) field of another bean, + as described in the API documentation for the + FieldRetrievingFactoryBean + class. + - Injecting enum values into beans as either property or constructor arguments is very - easy to do in Spring, in that you don't actually have to do - anything or know anything about the Spring internals (or even about classes such - as the FieldRetrievingFactoryBean). Let's look at an example - to see how easy injecting an enum value is; consider this JDK 5 enum: - + Injecting enum values into beans as either property or constructor arguments is very + easy to do in Spring, in that you don't actually have to do + anything or know anything about the Spring internals (or even about classes such + as the FieldRetrievingFactoryBean). Let's look at an example + to see how easy injecting an enum value is; consider this JDK 5 enum: + @@ -210,15 +210,15 @@ public class Client { ]]> - This works for classic type-safe emulated enums (on JDK 1.4 and JDK 1.3) as well; - Spring will automatically attempt to match the string property value to a constant - on the enum class. - + This works for classic type-safe emulated enums (on JDK 1.4 and JDK 1.3) as well; + Spring will automatically attempt to match the string property value to a constant + on the enum class. +
<literal><util:property-path/></literal> - Before... + Before... <!-- target bean to be referenced by name --> @@ -255,12 +255,12 @@ public class Client {
Using <literal><util:property-path/></literal> to set a bean property or constructor-argument PropertyPathFactoryBean is a - FactoryBean that evaluates a property path on a given - target object. The target object can be specified directly or via a bean - name. This value may then be used in another bean definition as a property - value or constructor argument. + FactoryBean that evaluates a property path on a given + target object. The target object can be specified directly or via a bean + name. This value may then be used in another bean definition as a property + value or constructor argument. Here's an example where a path is used against another bean, by name: - @@ -287,28 +287,28 @@ public class Client { ]]> - There is also a shortcut form, where the bean name is the property path. - <!-- will result in 10, which is the value of property 'age' of bean 'person' -->There is also a shortcut form, where the bean name is the property path. + <!-- will result in 10, which is the value of property 'age' of bean 'person' -->]]> This form does mean that there is no choice in the name of the bean. - Any reference to it will also have to use the same id, which is the path. - Of course, if used as an inner bean, there is no need to refer to it at - all: + Any reference to it will also have to use the same id, which is the path. + Of course, if used as an inner bean, there is no need to refer to it at + all: ]]> - The result type may be specifically set in the actual definition. - This is not necessary for most use cases, but can be of use for some. - Please see the Javadocs for more info on this feature. + The result type may be specifically set in the actual definition. + This is not necessary for most use cases, but can be of use for some. + Please see the Javadocs for more info on this feature.
<literal><util:properties/></literal> - Before... + Before... <!-- creates a java.util.Properties instance with values loaded from the supplied location --> @@ -324,7 +324,7 @@ public class Client {
<literal><util:list/></literal> - Before... + Before... <!-- creates a java.util.List instance with values loaded from the supplied 'sourceList' --> @@ -371,7 +371,7 @@ public class Client {
<literal><util:map/></literal> - Before... + Before... <!-- creates a java.util.Map instance with values loaded from the supplied 'sourceMap' --> @@ -418,7 +418,7 @@ public class Client {
<literal><util:set/></literal> - Before... + Before... <!-- creates a java.util.Set instance with values loaded from the supplied 'sourceSet' --> @@ -646,9 +646,9 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem
The <literal>jms</literal> schema The jms tags deal with configuring JMS-related - beans such as Spring's MessageListenerContainers. + beans such as Spring's MessageListenerContainers. These tags are detailed in the section of the JMS chapter - entitled . Please do consult that + entitled . Please do consult that chapter for full details on this support and the jms tags themselves. In the interest of completeness, to use the tags in the jms @@ -690,10 +690,10 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem available to you. xmlns:tx="http://www.springframework.org/schema/tx"xmlns:tx="http://www.springframework.org/schema/tx"http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd @@ -721,9 +721,9 @@ http://www.springframework.org/schema/aop http://www.springframework.org/schema/ available to you. xmlns:aop="http://www.springframework.org/schema/aop"xmlns:aop="http://www.springframework.org/schema/aop"http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd" @@ -735,70 +735,70 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem
The <literal>context</literal> schema The context tags deal with ApplicationContext - configuration that relates to plumbing - that is, not usually beans that are important to an end-user - but rather beans that do a lot of grunt work in Spring, such as BeanfactoryPostProcessors. + configuration that relates to plumbing - that is, not usually beans that are important to an end-user + but rather beans that do a lot of grunt work in Spring, such as BeanfactoryPostProcessors. The following snippet references the correct schema so that the tags in the context - namespace are available to you. + namespace are available to you. xmlns:context="http://www.springframework.org/schema/context"xmlns:context="http://www.springframework.org/schema/context"http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd" ]]><!-- <bean/> definitions here -->]]> - - The context schema was only introduced in Spring 2.5. - -
- <literal><property-placeholder/></literal> - This element activates the replacement of ${...} placeholders, resolved - against the specified properties file (as a Spring resource location). - This element is a convenience mechanism that sets up a - PropertyPlaceholderConfigurer - for you; if you need more control over the PropertyPlaceholderConfigurer, just - define one yourself explicitly. -
-
- <literal><annotation-config/></literal> - Activates the Spring infrastructure for various annotations to be detected in bean classes: - Spring's @Required - and @Autowired, as well as - JSR 250's @PostConstruct, @PreDestroy and - @Resource (if available), and JPA's - @PersistenceContext and @PersistenceUnit - (if available). Alternatively, you can choose to activate the individual - BeanPostProcessors for those annotations explictly. - - This element does not activate processing of Spring's - @Transactional - annotation. Use the - <tx:annotation-driven/> element - for that purpose. - -
-
- <literal><component-scan/></literal> - This element is detailed in . -
-
- <literal><load-time-weaver/></literal> - This element is detailed in . -
-
- <literal><spring-configured/></literal> - This element is detailed in . -
-
- <literal><mbean-export/></literal> - This element is detailed in . -
-
+ + The context schema was only introduced in Spring 2.5. + +
+ <literal><property-placeholder/></literal> + This element activates the replacement of ${...} placeholders, resolved + against the specified properties file (as a Spring resource location). + This element is a convenience mechanism that sets up a + PropertyPlaceholderConfigurer + for you; if you need more control over the PropertyPlaceholderConfigurer, just + define one yourself explicitly. +
+
+ <literal><annotation-config/></literal> + Activates the Spring infrastructure for various annotations to be detected in bean classes: + Spring's @Required + and @Autowired, as well as + JSR 250's @PostConstruct, @PreDestroy and + @Resource (if available), and JPA's + @PersistenceContext and @PersistenceUnit + (if available). Alternatively, you can choose to activate the individual + BeanPostProcessors for those annotations explictly. + + This element does not activate processing of Spring's + @Transactional + annotation. Use the + <tx:annotation-driven/> element + for that purpose. + +
+
+ <literal><component-scan/></literal> + This element is detailed in . +
+
+ <literal><load-time-weaver/></literal> + This element is detailed in . +
+
+ <literal><spring-configured/></literal> + This element is detailed in . +
+
+ <literal><mbean-export/></literal> + This element is detailed in . +
+
-
+
The <literal>tool</literal> schema The tool tags are for use when you want to add tooling-specific metadata to your custom configuration elements. This metadata @@ -850,15 +850,15 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem This final section documents the steps involved in setting up a number of popular Java IDEs to effect the easier editing of Spring's XML Schema-based configuration files. If your favourite Java IDE or editor is not included in the - list of documented IDEs, then please do + list of documented IDEs, then please do raise an issue and an example with your favorite IDE/editor may be included - in the next release. + in the next release.
Setting up Eclipse The following steps illustrate setting up - Eclipse to be XSD-aware. + Eclipse to be XSD-aware. The assumption in the following steps is that you already have an Eclipse project open (either a brand new project or an already existing one). @@ -880,16 +880,16 @@ http://www.springframework.org/schema/beans http://www.springframework.org/schem http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> ]]> - - - - - - - - - - + + + + + + + + + + Step Two @@ -898,36 +898,36 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema as plain text. There is no XML editing support out of the box in Eclipse, and as such there is not even any syntax highlighting of elements and attributes. To address this, you will have to install an XML editor plugin for Eclipse... - - Eclipse XML editors - - - - - XML Editor - Link - - - - - - The Eclipse Web Tools Platform (WTP) - - - - - - - - A list of Eclipse XML plugins - - - - - - - -
+ + Eclipse XML editors + + + + + XML Editor + Link + + + + + + The Eclipse Web Tools Platform (WTP) + + + + + + + + A list of Eclipse XML plugins + + + + + + + +
Contributing documentation... Patches showing how to configure an Eclipse XML editor are @@ -946,38 +946,38 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema Spring IDE There is a dedicated Spring Framework plugin for Eclipse called - Spring IDE and it is pretty darn cool. (There's a - considered and non-biased opinion for you!) This plugin makes using Spring even easier, and it has more - than just support for the core Spring Framework... Spring Web Flow is supported too. Details of how to - install Spring IDE can be found on the - Spring IDE installation page. - - - - - - - - - - - + Spring IDE and it is pretty darn cool. (There's a + considered and non-biased opinion for you!) This plugin makes using Spring even easier, and it has more + than just support for the core Spring Framework... Spring Web Flow is supported too. Details of how to + install Spring IDE can be found on the + Spring IDE installation page. + + + + + + + + + + + Web Tools Platform (WTP) for Eclipse If you are using the Web Tools Platform (WTP) for Eclipse, you don't need to do anything other than open a Spring XML configuration file using the WTP platform's XML editor. As can be seen in the screenshot below, you immediately get some slick IDE-level support for autocompleting tags and suchlike. - - - - - - - - - - + + + + + + + + + +
@@ -1002,16 +1002,16 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> ]]> - - - - - - - - - - + + + + + + + + + + Step Two @@ -1022,20 +1022,20 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema area (see the screenshot below); then press the Alt Enter - keystroke combination, and press the + keystroke combination, and press the Enter key again when the popup becomes active to fetch the external resource. - - - - - - - - - - + + + + + + + + + + Step Three @@ -1048,16 +1048,16 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema S keystroke combination or via the 'File|Settings' menu), and click on the 'Resources' button. - - - - - - - - - - + + + + + + + + + + Step Four @@ -1065,16 +1065,16 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema that allows you to add an explicit reference to a local copy of the util schema file. (You can find all of the various Spring XSD files in the 'src' directory of the Spring distribution.) - - - - - - - - - - + + + + + + + + + + Step Five @@ -1084,16 +1084,16 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema 'http://www.springframework.org/schema/util' namespace is being associated with the file resource 'C:\bench\spring\src\org\springframework\beans\factory\xml\spring-util-3.0.xsd'. - - - - - - - - - - + + + + + + + + + + Step Six @@ -1103,21 +1103,21 @@ http://www.springframework.org/schema/util http://www.springframework.org/schema the '<' character into the editing window now also brings up a handy dropdown box that contains all of the imported tags from the util namespace. - - - - - - - - - - + + + + + + + + + + Repeat as required for setting up IDEA to reference the other Spring XSD files.
- +
Integration issues This final section details integration issues that may arise when you switch over