You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by ve...@apache.org on 2012/12/23 18:25:12 UTC
svn commit: r1425490 - in
/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom:
mime/impl/javamail/ om/impl/ om/impl/dom/jaxp/ om/impl/exception/
om/impl/llom/factory/ om/impl/llom/util/ om/util/
Author: veithen
Date: Sun Dec 23 17:25:11 2012
New Revision: 1425490
URL: http://svn.apache.org/viewvc?rev=1425490&view=rev
Log:
Ensure that all classes in axiom-compat are marked as deprecated.
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/JavaMailMultipartWriterFactory.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/package.html
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/EmptyOMLocation.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderFactoryImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/exception/XMLComparisonException.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/factory/OMXMLBuilderFactory.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/util/XMLComparator.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/TextHelper.java
webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/UUIDGenerator.java
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/JavaMailMultipartWriterFactory.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/JavaMailMultipartWriterFactory.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/JavaMailMultipartWriterFactory.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/JavaMailMultipartWriterFactory.java Sun Dec 23 17:25:11 2012
@@ -23,9 +23,16 @@ import java.io.OutputStream;
import org.apache.axiom.mime.MultipartWriter;
import org.apache.axiom.mime.MultipartWriterFactory;
+import org.apache.axiom.mime.impl.axiom.AxiomMultipartWriterFactory;
/**
* Factory for the JavaMail based {@link MultipartWriter} implementation.
+ *
+ * @deprecated The original purpose of this class was to provide an alternative implementation
+ * should bugs be discovered in {@link AxiomMultipartWriterFactory}. However,
+ * {@link AxiomMultipartWriterFactory} exists for several releases now and has no known
+ * issues. It should therefore always be used as {@link MultipartWriterFactory}
+ * implementation.
*/
public class JavaMailMultipartWriterFactory implements MultipartWriterFactory {
public static final MultipartWriterFactory INSTANCE = new JavaMailMultipartWriterFactory();
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/package.html
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/package.html?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/package.html (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/mime/impl/javamail/package.html Sun Dec 23 17:25:11 2012
@@ -18,6 +18,6 @@
-->
<html>
<body>
-MIME message processing API implementation based on JavaMail.
+MIME message processing API implementation based on JavaMail (deprecated).
</body>
</html>
\ No newline at end of file
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/EmptyOMLocation.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/EmptyOMLocation.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/EmptyOMLocation.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/EmptyOMLocation.java Sun Dec 23 17:25:11 2012
@@ -22,7 +22,7 @@ package org.apache.axiom.om.impl;
import org.apache.axiom.util.stax.DummyLocation;
/**
- * @deprecated use {@link DummyLocation#INSTANCE} instead
+ * @deprecated Use {@link DummyLocation#INSTANCE} instead.
*/
public class EmptyOMLocation extends DummyLocation {
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderFactoryImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderFactoryImpl.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderFactoryImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderFactoryImpl.java Sun Dec 23 17:25:11 2012
@@ -33,10 +33,16 @@ import org.apache.axiom.om.dom.DOMMetaFa
* DOM implementation as returned by JAXP. This was a hack introduced for Rampart.
* Recent versions of Rampart no longer rely on this hack. On the other hand
* usage of {@link #setDOOMRequired(boolean)} in a concurrent environment can
- * lead to unexpected behavior and severe bugs, as shown in AXIOM-3 and AXIS2-1570.
+ * lead to unexpected behavior and severe bugs, as shown in
+ * <a href="https://issues.apache.org/jira/browse/AXIOM-3">AXIOM-3</a> and
+ * <a href="https://issues.apache.org/jira/browse/AXIS2-1570">AXIS2-1570</a>.
* Due to the way {@link #newDocumentBuilder()} is implemented, it is not possible
* to get rid of the setDOOMRequired hack without the risk of breaking existing code.
- * Therefore this class has been deprecated in favor of {@link DOOMDocumentBuilderFactory}.
+ * <p>
+ * Application code should always use {@link DOMMetaFactory#newDocumentBuilderFactory()}
+ * to get an Axiom compatible {@link DocumentBuilderFactory} and should not attempt to
+ * override the JVM's default {@link DocumentBuilderFactory} with an Axiom compatible
+ * version.
*/
public class DocumentBuilderFactoryImpl extends DocumentBuilderFactory {
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderImpl.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/dom/jaxp/DocumentBuilderImpl.java Sun Dec 23 17:25:11 2012
@@ -41,7 +41,7 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * @deprecated see {@link DocumentBuilderFactoryImpl}
+ * @deprecated See {@link DocumentBuilderFactoryImpl} for the reason why this class is deprecated.
*/
public class DocumentBuilderImpl extends DocumentBuilder {
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/exception/XMLComparisonException.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/exception/XMLComparisonException.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/exception/XMLComparisonException.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/exception/XMLComparisonException.java Sun Dec 23 17:25:11 2012
@@ -19,6 +19,11 @@
package org.apache.axiom.om.impl.exception;
+import org.apache.axiom.om.impl.llom.util.XMLComparator;
+
+/**
+ * @deprecated This exception is only used by {@link XMLComparator} which is deprecated.
+ */
public class XMLComparisonException extends Exception {
private static final long serialVersionUID = -7918497983548520994L;
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/factory/OMXMLBuilderFactory.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/factory/OMXMLBuilderFactory.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/factory/OMXMLBuilderFactory.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/factory/OMXMLBuilderFactory.java Sun Dec 23 17:25:11 2012
@@ -27,8 +27,6 @@ import org.apache.axiom.soap.impl.builde
import javax.xml.stream.XMLStreamReader;
/**
- * Class OMXMLBuilderFactory
- *
* @deprecated This class is deprecated because it is located in the wrong package and JAR
* (it is implementation independent but belongs to LLOM). Please use
* {@link org.apache.axiom.om.OMXMLBuilderFactory} instead.
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/util/XMLComparator.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/util/XMLComparator.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/util/XMLComparator.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/impl/llom/util/XMLComparator.java Sun Dec 23 17:25:11 2012
@@ -31,7 +31,9 @@ import java.util.Iterator;
import java.util.Vector;
-/** @deprecated This class is outdated. Please use XmlUnit to compate two xml files. */
+/**
+ * @deprecated This class is no longer maintained. Please use XmlUnit to compare XML documents.
+ */
public class XMLComparator {
private static final Log log = LogFactory.getLog(XMLComparator.class);
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/TextHelper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/TextHelper.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/TextHelper.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/TextHelper.java Sun Dec 23 17:25:11 2012
@@ -36,6 +36,9 @@ import org.apache.axiom.om.OMText;
import org.apache.axiom.util.base64.Base64EncodingStringBufferOutputStream;
import org.apache.axiom.util.base64.Base64Utils;
+/**
+ * @deprecated Class containing only deprecated utility methods.
+ */
public class TextHelper {
/**
* @deprecated
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/UUIDGenerator.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/UUIDGenerator.java?rev=1425490&r1=1425489&r2=1425490&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/UUIDGenerator.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-compat/src/main/java/org/apache/axiom/om/util/UUIDGenerator.java Sun Dec 23 17:25:11 2012
@@ -27,12 +27,14 @@ import java.util.Date;
import java.util.Random;
import org.apache.axiom.om.OMException;
+import org.apache.axiom.util.UIDGenerator;
/**
- * @deprecated Please use one of the specialized methods in the
- * {@link org.apache.axiom.util.UIDGenerator} class. In contrast to what its name
- * suggests, the {@link #getUUID()} method doesn't return a UUID. It also doesn't return
- * a valid URN with uuid NID. See AXIS2-4527 for more information.
+ * @deprecated Please use one of the specialized methods in the {@link UIDGenerator} class. In
+ * contrast to what its name suggests, the {@link #getUUID()} method doesn't return a
+ * UUID. It doesn't return a valid URN with uuid NID either. See <a
+ * href="https://issues.apache.org/jira/browse/AXIS2-4527">AXIS2-4527</a> for more
+ * information.
*/
public class UUIDGenerator {
/** This class will give UUIDs for axis2. */