Author: nick
Date: Mon Jan 9 22:38:32 2012
New Revision: 1229406
URL: http://svn.apache.org/viewvc?rev=1229406&view=rev
Log:
VALIDATOR-300 - Apply patch from Jacob Zwiers to update documentation following
the ORO dependency removal
Modified:
commons/proper/validator/trunk/RELEASE-NOTES.txt
commons/proper/validator/trunk/build.properties.sample
commons/proper/validator/trunk/build.xml
commons/proper/validator/trunk/src/site/xdoc/tasks.xml
Modified: commons/proper/validator/trunk/RELEASE-NOTES.txt
URL:
http://svn.apache.org/viewvc/commons/proper/validator/trunk/RELEASE-NOTES.txt?rev=1229406&r1=1229405&r2=1229406&view=diff
==============================================================================
--- commons/proper/validator/trunk/RELEASE-NOTES.txt (original)
+++ commons/proper/validator/trunk/RELEASE-NOTES.txt Mon Jan 9 22:38:32 2012
@@ -37,8 +37,10 @@ DEPENDENCIES
=============
The dependencies for Validator 1.4 have only one change since the 1.3.1
-release, in that the Jakarta ORO dependency has been removed.
-(See http://commons.apache.org/validator/dependencies.html)
+release, in that the Jakarta ORO dependency has been removed (VALIDATOR-193).
+
+For the current list of dependencies, please see
+http://commons.apache.org/validator/dependencies.html
BUGS FROM PREVIOUS RELEASE
===========================
@@ -111,10 +113,20 @@ IMPROVEMENTS OVER PREVIOUS RELEASE
DEPRECATIONS
============
- * NONE
+ * Most of the org.apache.commons.validator classes have been deprecated,
+ in favour of the new org.apache.commons.validator.routines classes.
OTHER NOTES
============
- * NONE
-
\ No newline at end of file
+Users should be aware of the following potential issues with migration:
+
+ * The protected method validator.EmailValidator.isValidIpAddress() previously
+ exposed a Jakarta ORO class via its signature. The signature has been
+ modified to accept a a java.lang.String and is not therefore not compatible.
+ However, this class is deprecated and clients should use the equivalent
+ class in the validator.routines package.
+
+* Invocations of the method GenericValidator.matchRegexp() should be inspected
+ for semantic differences between Jakarta ORO and Java regular expressions.
+
Modified: commons/proper/validator/trunk/build.properties.sample
URL:
http://svn.apache.org/viewvc/commons/proper/validator/trunk/build.properties.sample?rev=1229406&r1=1229405&r2=1229406&view=diff
==============================================================================
--- commons/proper/validator/trunk/build.properties.sample (original)
+++ commons/proper/validator/trunk/build.properties.sample Mon Jan 9 22:38:32
2012
@@ -36,10 +36,6 @@ commons-digester.jar=../digester/dist/co
# from the Jakarta Commons project.
commons-logging.jar=../logging/dist/commons-logging.jar
-# The JAR file containing version 2.0.8 (or later) of
-# the the Jakarta ORO project.
-oro.jar=${apache.dir}/jakarta-oro-2.0.8/jakarta-oro-2.0.8.jar
-
# The JAR file containing version 3.8.1 (or later) of
# JUnit Unit Testing (http://www.junit.org)
junit.jar=D:/java/Lib/junit3.8.1/junit.jar
Modified: commons/proper/validator/trunk/build.xml
URL:
http://svn.apache.org/viewvc/commons/proper/validator/trunk/build.xml?rev=1229406&r1=1229405&r2=1229406&view=diff
==============================================================================
--- commons/proper/validator/trunk/build.xml (original)
+++ commons/proper/validator/trunk/build.xml Mon Jan 9 22:38:32 2012
@@ -133,7 +133,6 @@
<pathelement location="${commons-beanutils.jar}"/>
<pathelement location="${commons-digester.jar}"/>
<pathelement location="${commons-logging.jar}"/>
- <pathelement location="${oro.jar}"/>
<path refid="downloaded.lib.classpath"/>
</path>
@@ -142,7 +141,6 @@
<pathelement location="${download.lib.dir}/commons-beanutils.jar"/>
<pathelement location="${download.lib.dir}/commons-digester.jar"/>
<pathelement location="${download.lib.dir}/commons-logging.jar"/>
- <pathelement location="${download.lib.dir}/oro.jar"/>
<pathelement location="${download.lib.dir}/junit.jar"/>
</path>
@@ -156,7 +154,6 @@
<pathelement location="${commons-beanutils.jar}"/>
<pathelement location="${commons-digester.jar}"/>
<pathelement location="${commons-logging.jar}"/>
- <pathelement location="${oro.jar}"/>
<pathelement location="${junit.jar}"/>
<pathelement location="${xerces.jar}"/>
<path refid="downloaded.lib.classpath"/>
@@ -279,7 +276,7 @@
<target name="javadoc" depends="compile, javadoc.js"
description="Create component Javadoc documentation">
- <javadoc sourcepath="${source.home}"
+ <!--javadoc sourcepath="${source.home}"
destdir="${dist.home}/docs/apidocs"
packagenames="org.apache.commons.*"
author="true"
@@ -288,7 +285,7 @@
doctitle="<h1>${component.title} (Version
${component.version})</h1>"
windowtitle="${component.title} (Version ${component.version})"
bottom="Copyright (c) 2001-2004 Apache Software Foundation"
- classpathref="compile.classpath" />
+ classpathref="compile.classpath" / -->
</target>
@@ -474,7 +471,6 @@
<antcall target="download-beanutils" />
<antcall target="download-digester" />
<antcall target="download-logging" />
- <antcall target="download-oro" />
<antcall target="download-junit" />
</target>
@@ -483,7 +479,6 @@
<available file="${commons-beanutils.jar}"
property="beanutils.found"/>
<available file="${commons-digester.jar}" property="digester.found"/>
<available file="${commons-logging.jar}" property="logging.found"/>
- <available file="${oro.jar}" property="oro.found"/>
<available file="${junit.jar}" property="junit.found"/>
</target>
@@ -511,14 +506,6 @@
src="http://www.ibiblio.org/maven/commons-logging/jars/commons-logging-1.0.4.jar"/>
</target>
- <target name="download-oro" unless="oro.found">
- <echo message="Downloading oro..."/>
- <mkdir dir="${download.lib.dir}" />
- <get dest="${download.lib.dir}/oro.jar"
- usetimestamp="true" ignoreerrors="true"
- src="http://www.ibiblio.org/maven/oro/jars/oro-2.0.8.jar"/>
- </target>
-
<target name="download-junit" unless="junit.found">
<echo message="Downloading junit..."/>
<mkdir dir="${download.lib.dir}" />
Modified: commons/proper/validator/trunk/src/site/xdoc/tasks.xml
URL:
http://svn.apache.org/viewvc/commons/proper/validator/trunk/src/site/xdoc/tasks.xml?rev=1229406&r1=1229405&r2=1229406&view=diff
==============================================================================
--- commons/proper/validator/trunk/src/site/xdoc/tasks.xml (original)
+++ commons/proper/validator/trunk/src/site/xdoc/tasks.xml Mon Jan 9 22:38:32
2012
@@ -51,29 +51,6 @@
to use configuration semantics specific to their domain.
</li>
<li>
- Examine the need for all dependencies. Validator has many
dependencies that are very lightly used
- and could be removed. Two likely candidates for removal are
commons-collections and ORO. The first
- because Validator only uses one class in a very large jar and
backward incompatible changes in recent
- versions. The second because it can easily be replaced with the
faster and standard Java 1.4 regex
- engine.
- </li>
- <li>
- Scenario one:
- Replace the Jakarta ORO regex engine with the standard Java 1.4
engine. Preliminary tests show a
- 50% speed improvement using the standard engine. This will remove
the ORO dependency and
- bring Validator in line with standard Java regular expressions.
However, this requires a move
- to Java 1.4 as the base required Java version. A good time for this
move may be Validator 2.0 when
- we also change the configuration file semantics.
- </li>
- <li>
- Scenario two:
- ORO provides a much richer interface to regular expressions, such
that we don't have
- to worry about bit twiddling, this includes a pluggable regex
engine. Jeffrey E Friedl states
- in Mastering Regular Expressions 2ed, says that in speaking to the
ORO developers that they
- will likely develop an adapter to the Java 1.4 regex, See page 378.
So we get use of ORO and the speed of
- Java 1.4 Regex engine.
- </li>
- <li>
ValidatorException is only thrown to indicate configuration and
programmer errors
yet is a checked exception. ValidatorException should be
converted to a RuntimeException to match its
real purpose. Furthermore, the exception handling for pluggable
validations (ValidatorActions)
