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 2013/09/22 10:16:21 UTC
svn commit: r1525330 - /webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java

Author: veithen
Date: Sun Sep 22 08:16:21 2013
New Revision: 1525330

URL: http://svn.apache.org/r1525330
Log:
Improved Javadoc.

Modified:
    webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java

Modified: webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java?rev=1525330&r1=1525329&r2=1525330&view=diff
==============================================================================
--- webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java (original)
+++ webservices/axiom/trunk/modules/axiom-api/src/main/java/org/apache/axiom/om/OMAbstractFactory.java Sun Sep 22 08:16:21 2013
@@ -58,6 +58,14 @@ import org.apache.axiom.soap.SOAPFactory
  * <p>
  */
 public class OMAbstractFactory {
+    /**
+     * The name of the system property that allows to override the default Axiom implementation. The
+     * value must be the fully qualified name of a class implementing {@link OMMetaFactory} and that
+     * is visible to the class loader from which the <tt>axiom-api</tt> library is loaded. An
+     * instance of this class will be returned by {@link #getMetaFactory()}.
+     * <p>
+     * Note that this system property is not supported in an OSGi environment.
+     */
     public static final String META_FACTORY_NAME_PROPERTY = "org.apache.axiom.om.OMMetaFactory";
 
     /**
@@ -176,7 +184,9 @@ public class OMAbstractFactory {
     }
     
     /**
-     * Get the default OM factory instance.
+     * Get the default OM factory instance. This method has the same effect as calling
+     * {@link OMMetaFactory#getOMFactory()} on the {@link OMMetaFactory} instance returned by
+     * {@link #getMetaFactory()}.
      *
      * @return the default OM factory instance
      * @throws OMException if the factory's implementation class can't be found
@@ -188,7 +198,9 @@ public class OMAbstractFactory {
 
 
     /**
-     * Get the default SOAP 1.1 OM factory instance.
+     * Get the default SOAP 1.1 OM factory instance. This method has the same effect as calling
+     * {@link OMMetaFactory#getSOAP11Factory()} on the {@link OMMetaFactory} instance returned by
+     * {@link #getMetaFactory()}.
      *
      * @return the default SOAP 1.1 OM factory instance
      * @throws OMException if the factory's implementation class can't be found
@@ -200,7 +212,9 @@ public class OMAbstractFactory {
 
 
     /**
-     * Get the default SOAP 1.2 OM factory instance.
+     * Get the default SOAP 1.2 OM factory instance. This method has the same effect as calling
+     * {@link OMMetaFactory#getSOAP12Factory()} on the {@link OMMetaFactory} instance returned by
+     * {@link #getMetaFactory()}.
      *
      * @return the default SOAP 1.2 OM factory instance
      * @throws OMException if the factory's implementation class can't be found