Improve documentation.

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / ant / spring / AbstractSpringArg.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/AbstractSpringArg.java b/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/AbstractSpringArg.java
index 4061f377ff21b295aa6357070d0e2f21458f0c7c..86757751bd556d1bd03bb936a5bf04f7198bcdb0 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/AbstractSpringArg.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/spring/AbstractSpringArg.java
@@ -13,19 +13,26 @@ import org.apache.tools.ant.types.DataType;
 \r
 import org.argeo.slc.ant.SlcProjectHelper;\r
 \r
+/** Abstract Ant type wrapping a Spring bean. */\r
 public abstract class AbstractSpringArg extends DataType {\r
        private List<OverrideArg> overrides = new Vector<OverrideArg>();\r
 \r
        private String bean;\r
 \r
+       /** The <u>name</u> of the underlying bean, as set throught the attribute. */\r
        public String getBean() {\r
                return bean;\r
        }\r
 \r
+       /** Setter for the bean name. */\r
        public void setBean(String bean) {\r
                this.bean = bean;\r
        }\r
 \r
+       /**\r
+        * Retrieve the instance of the bean. <b>If teh underlying Spring bean is a\r
+        * prototype, it will instanciated each time.</b>\r
+        */\r
        protected Object getBeanInstance() {\r
                Object obj = getContext().getBean(bean);\r
 \r
@@ -37,12 +44,14 @@ public abstract class AbstractSpringArg extends DataType {
                return obj;\r
        }\r
 \r
+       /** Creates an override subtag.*/\r
        public OverrideArg createOverride() {\r
                OverrideArg propertyArg = new OverrideArg();\r
                overrides.add(propertyArg);\r
                return propertyArg;\r
        }\r
 \r
+       /** The related Spring application context.*/\r
        protected ApplicationContext getContext() {\r
                return (ApplicationContext) getProject().getReference(\r
                                SlcProjectHelper.REF_ROOT_CONTEXT);\r