From e829c2104fdd128290b255d0de78c7dc23b73bba Mon Sep 17 00:00:00 2001
From: Mathieu Baudier <mbaudier@argeo.org>
Date: Wed, 24 Oct 2007 15:25:27 +0000
Subject: [PATCH 1/1] Add taskdefs.property

git-svn-id: https://svn.argeo.org/slc/trunk@639 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc
---
 org.argeo.slc/javadoc.xml                     |  6 +++++
 .../org/argeo/slc/ant/AntRegistryUtil.java    |  5 +++-
 .../org/argeo/slc/ant/SlcProjectHelper.java   | 25 +++++++++++--------
 .../main/java/org/argeo/slc/ant/package.html  | 14 +++++++++++
 .../org/argeo/slc/ant/taskdefs.properties     |  1 +
 org.argeo.slc/src/test/ant/build.xml          |  2 +-
 6 files changed, 41 insertions(+), 12 deletions(-)
 create mode 100644 org.argeo.slc/javadoc.xml
 create mode 100644 org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
 create mode 100644 org.argeo.slc/src/main/java/org/argeo/slc/ant/taskdefs.properties

diff --git a/org.argeo.slc/javadoc.xml b/org.argeo.slc/javadoc.xml
new file mode 100644
index 000000000..990bb4617
--- /dev/null
+++ b/org.argeo.slc/javadoc.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project default="javadoc">
+<target name="javadoc">
+<javadoc access="public" author="true" classpath="lib/commons-logging.jar;lib/ant-launcher.jar;lib/spring-2.0.6.jar;lib/ant.jar" destdir="doc" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="org.argeo.slc.ant,org.argeo.slc.core.structure.tree,org.argeo.slc.core.test,org.argeo.slc.ant.test,org.argeo.slc.core.structure,org.argeo.slc.ant.spring,org.argeo.slc.ant.structure" source="1.5" sourcepath="src/test/java;src/main/java" splitindex="true" use="true" version="true"/>
+</target>
+</project>
diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/AntRegistryUtil.java b/org.argeo.slc/src/main/java/org/argeo/slc/ant/AntRegistryUtil.java
index a871d6fde..356a7c748 100644
--- a/org.argeo.slc/src/main/java/org/argeo/slc/ant/AntRegistryUtil.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/AntRegistryUtil.java
@@ -13,9 +13,11 @@ import org.argeo.slc.core.structure.StructureElement;
 import org.argeo.slc.core.structure.StructurePath;
 import org.argeo.slc.core.structure.StructureRegistry;
 
+/** Utilities to manipulate the structure registry in SLC Ant.*/
 public class AntRegistryUtil {
 	private static Log log = LogFactory.getLog(AntRegistryUtil.class);
 
+	/** Read a structure registry from an Ant file without executing it. */
 	public static StructureRegistry readRegistry(File antFile) {
 
 		Project p = new Project();
@@ -33,6 +35,7 @@ public class AntRegistryUtil {
 		return registry;
 	}
 
+	/** Execute only the active paths of teh Ant files. */
 	public static void runActive(File antFile, List<StructurePath> activePaths) {
 
 		Project p = new Project();
@@ -43,7 +46,7 @@ public class AntRegistryUtil {
 		helper.parse(p, antFile);
 
 		StructureRegistry registry = (StructureRegistry) p
-		.getReference(SlcProjectHelper.REF_STRUCTURE_REGISTRY);
+				.getReference(SlcProjectHelper.REF_STRUCTURE_REGISTRY);
 		registry.setMode(StructureRegistry.ACTIVE);
 		registry.setActivePaths(activePaths);
 		p.executeTarget(p.getDefaultTarget());
diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/SlcProjectHelper.java b/org.argeo.slc/src/main/java/org/argeo/slc/ant/SlcProjectHelper.java
index 2eb703e90..e08ec4305 100644
--- a/org.argeo.slc/src/main/java/org/argeo/slc/ant/SlcProjectHelper.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/SlcProjectHelper.java
@@ -11,9 +11,14 @@ import org.argeo.slc.core.structure.DefaultSRegistry;
 import org.argeo.slc.core.structure.tree.TreeSElement;
 import org.argeo.slc.core.structure.tree.TreeSPath;
 
+/**
+ * Custom implementation of a <code>ProjectHelper</code> binding a Spring
+ * application context and a structure registry with the Ant project.
+ */
 public class SlcProjectHelper extends ProjectHelperImpl {
 	public static String PROP_APPLICATION_CONTEXT = "org.argeo.slc.slcRootContext";
-	//public static String PROP_REGISTRY_MODE = "org.argeo.slc.slcRegistryMode";
+	// public static String PROP_REGISTRY_MODE =
+	// "org.argeo.slc.slcRegistryMode";
 	public static String REF_ROOT_CONTEXT = "slcApplicationContext";
 	public static String REF_STRUCTURE_REGISTRY = "slcStructureRegistry";
 
@@ -29,23 +34,23 @@ public class SlcProjectHelper extends ProjectHelperImpl {
 
 		// init structure register if it does not exist
 		DefaultSRegistry registry = new DefaultSRegistry();
-			project.addReference(REF_STRUCTURE_REGISTRY, registry);
+		project.addReference(REF_STRUCTURE_REGISTRY, registry);
 
-			// call the underlying implementation to do the actual work
-			super.parse(project, source);
+		// call the underlying implementation to do the actual work
+		super.parse(project, source);
 
-			String projectDescription = project.getDescription() != null ? project
-					.getDescription()
-					: "Root";
-			TreeSElement element = TreeSElement.createRootElelment(
-					getProjectPathName(project), projectDescription);
-			registry.register(element);
+		String projectDescription = project.getDescription() != null ? project
+				.getDescription() : "Root";
+		TreeSElement element = TreeSElement.createRootElelment(
+				getProjectPathName(project), projectDescription);
+		registry.register(element);
 	}
 
 	private static void stdOut(Object o) {
 		System.out.println(o);
 	}
 
+	/** Get the path of a project (root).*/
 	public static TreeSPath getProjectPath(Project project) {
 		return TreeSPath.createChild(null, getProjectPathName(project));
 	}
diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html b/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
new file mode 100644
index 000000000..14a54d1af
--- /dev/null
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/package.html
@@ -0,0 +1,14 @@
+<html>
+<head></head>
+<body>
+Bases classes for SLC Ant extensions.
+<h2>Usage of SLC Ant extensions</h2>
+Add:
+<pre>
+&lt;taskdef resource="org/argeo/slc/ant/taskdefs.properties" /&gt;
+</pre>
+at the beginning of your file.
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/ant/taskdefs.properties b/org.argeo.slc/src/main/java/org/argeo/slc/ant/taskdefs.properties
new file mode 100644
index 000000000..4df33bd69
--- /dev/null
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/ant/taskdefs.properties
@@ -0,0 +1 @@
+slc.test=org.argeo.slc.ant.test.SlcTestTask
\ No newline at end of file
diff --git a/org.argeo.slc/src/test/ant/build.xml b/org.argeo.slc/src/test/ant/build.xml
index 76fa1c79b..ec1cfb5a3 100644
--- a/org.argeo.slc/src/test/ant/build.xml
+++ b/org.argeo.slc/src/test/ant/build.xml
@@ -1,7 +1,7 @@
 <project default="test" name="testProject">
 	<description>A Test project</description>
 	
-	<taskdef name="slc.test" classname="org.argeo.slc.ant.test.SlcTestTask" />
+	<taskdef resource="org/argeo/slc/ant/taskdefs.properties" />
 
 	<target name="test" depends="testSimple,testObj">
 	</target>
-- 
2.39.2