svn commit: r375358 - in /jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id: task/UUIDTask.java task/uuid.xml uuid/task/ uuid/task/UUIDTask.java uuid/task/package.html

[jo...@apache.org]

Author: joehni
Date: Mon Feb  6 12:33:09 2006
New Revision: 375358

URL: http://svn.apache.org/viewcvs?rev=375358&view=rev
Log:
Move the Ant task below package uuid and describe it.

Added:
    jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/
    jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/UUIDTask.java
      - copied, changed from r375342, jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/UUIDTask.java
    jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html   (with props)
Removed:
    jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/UUIDTask.java
    jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/uuid.xml

Copied: jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/UUIDTask.java (from r375342, jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/UUIDTask.java)
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/UUIDTask.java?p2=jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/UUIDTask.java&p1=jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/UUIDTask.java&r1=375342&r2=375358&rev=375358&view=diff
==============================================================================
--- jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/task/UUIDTask.java (original)
+++ jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/UUIDTask.java Mon Feb  6 12:33:09 2006
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.apache.commons.id.task;
+package org.apache.commons.id.uuid.task;
 
 import org.apache.commons.id.uuid.UUID;
 import org.apache.tools.ant.BuildException;
@@ -22,8 +22,28 @@
 import org.apache.tools.ant.types.EnumeratedAttribute;
 
 /**
- * Simple Ant task to generate a UUID.
+ * Simple Ant task to generate a UUID. See the following Ant script for usage:
+ * <pre>
+ * &lt;project default="generate.uuid" name="uuid" basedir="."&gt;
+ * 
+ *   &lt;taskdef name="uuid" className="org.apache.commons.id.task.UUIDTask"/&gt;
+ * 
+ *   &lt;target name="generate.uuid" description="Generates a UUID"&gt;
+ *     &lt;uuid version="VERSION_ONE"/&gt;
+ *     &lt;echo message="${uuid}"/&gt; 
+ *     &lt;uuid version="VERSION_THREE"/&gt; 
+ *     &lt;echo message="${uuid}"/&gt;
+ *     &lt;uuid version="VERSION_FOUR"/&gt; 
+ *     &lt;echo message="${uuid}"/&gt;
+ *     &lt;uuid version="VERSION_FIVE"/&gt; 
+ *     &lt;echo message="${uuid}"/&gt;
+ *   &lt;/target&gt;
+ * &lt;/project&gt;
+ * </pre>
+ * The namespace <em>urn:uuid:B4F00409-CEF8-4822-802C-DEB20704C365</em> and the name
+ * <em>www.apache.org</em> is used to generate the UUIDs for version 3 and 5.
  * $Id$
+ * @since 1.0
  */
 public class UUIDTask extends Task {
 	
@@ -39,6 +59,10 @@
 		this.namespace = namespace;
 	}
 	
+	/**
+	 * The enum for the UUID version.
+	 * @since 1.0
+	 */
 	public static class UUIDVersion extends EnumeratedAttribute {
 		public String[] getValues() {
 			return new String[] { "VERSION_ONE", "VERSION_THREE", "VERSION_FOUR", "VERSION_FIVE" };

Added: jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html?rev=375358&view=auto
==============================================================================
--- jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html (added)
+++ jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html Mon Feb  6 12:33:09 2006
@@ -0,0 +1,20 @@
+<!--
+   Copyright 2006 The Apache Software Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+  -->
+<body>
+  <p>
+    This package contains an Ant task to generate UUIDs.
+  </p>
+</body>
\ No newline at end of file

Propchange: jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jakarta/commons/sandbox/id/trunk/src/java/org/apache/commons/id/uuid/task/package.html
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org