axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r365972 - in /webservices/axis2/trunk/java/modules: core/src/org/apache/axis2/deployment/scheduler/ core/src/org/apache/axis2/deployment/util/ xml/src/org/apache/axis2/om/ xml/src/org/apache/axis2/om/impl/ xml/src/org/apache/axis2/soap/
Date Wed, 04 Jan 2006 19:45:24 GMT
Author: dims
Date: Wed Jan  4 11:45:13 2006
New Revision: 365972

URL: http://svn.apache.org/viewcvs?rev=365972&view=rev
Log:
javadoc updates

Modified:
    webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/scheduler/SchedulerTask.java
    webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/util/Utils.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAbstractFactory.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAttribute.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMComment.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMContainer.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocType.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMElement.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMFactory.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNamespace.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNode.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMOutputFormat.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMProcessingInstruction.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMText.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMXMLParserWrapper.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MIMEOutputUtils.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MTOMConstants.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMContainerEx.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMNodeEx.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMOutputImpl.java
    webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPFactory.java

Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/scheduler/SchedulerTask.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/scheduler/SchedulerTask.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/scheduler/SchedulerTask.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/scheduler/SchedulerTask.java Wed Jan  4 11:45:13 2006
@@ -42,7 +42,7 @@
      * <p/>
      * This method may be called repeatedly; the second and subsequent calls have no effect.
      *
-     * @return true if this task was already scheduled to run
+     * @return Returns true if this task was already scheduled to run.
      */
     public boolean cancel() {
         synchronized (lock) {

Modified: webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/util/Utils.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/util/Utils.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/util/Utils.java (original)
+++ webservices/axis2/trunk/java/modules/core/src/org/apache/axis2/deployment/util/Utils.java Wed Jan  4 11:45:13 2006
@@ -1,191 +1,191 @@
-package org.apache.axis2.deployment.util;
-
-import org.apache.axis2.AxisFault;
-import org.apache.axis2.Constants;
-import org.apache.axis2.deployment.DeploymentException;
-import org.apache.axis2.description.*;
-import org.apache.axis2.engine.Handler;
-import org.apache.axis2.wsdl.java2wsdl.SchemaGenerator;
-import org.apache.axis2.wsdl.java2wsdl.TypeTable;
-import org.apache.wsdl.WSDLConstants;
-import org.codehaus.jam.JMethod;
-
-import javax.xml.namespace.QName;
-import java.io.File;
-import java.net.MalformedURLException;
-import java.net.URL;
-import java.net.URLClassLoader;
-import java.util.ArrayList;
-
-/*
-* Copyright 2004,2005 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.
-*
-*/
-
-public class Utils {
-    public static void addFlowHandlers(Flow flow, ClassLoader clsLoader) throws AxisFault {
-        int count = flow.getHandlerCount();
-
-        for (int j = 0; j < count; j++) {
-            HandlerDescription handlermd = flow.getHandler(j);
-            Class handlerClass;
-            Handler handler;
-
-            handlerClass = getHandlerClass(handlermd.getClassName(), clsLoader);
-
-            try {
-                handler = (Handler) handlerClass.newInstance();
-                handler.init(handlermd);
-                handlermd.setHandler(handler);
-            } catch (InstantiationException e) {
-                throw new AxisFault(e);
-            } catch (IllegalAccessException e) {
-                throw new AxisFault(e);
-            }
-        }
-    }
-
-    public static void loadHandler(ClassLoader loader1, HandlerDescription desc)
-            throws DeploymentException {
-        String handlername = desc.getClassName();
-        Handler handler;
-        Class handlerClass;
-
-        try {
-            handlerClass = Class.forName(handlername, true, loader1);
-            handler = (Handler) handlerClass.newInstance();
-            handler.init(desc);
-            desc.setHandler(handler);
-        } catch (ClassNotFoundException e) {
-            throw new DeploymentException(e);
-        } catch (Exception e) {
-            throw new DeploymentException(e);
-        }
-    }
-
-    public static ClassLoader getClassLoader(ClassLoader parent, String path)
-            throws DeploymentException {
-        return getClassLoader(parent, new File(path));
-    }
-    
-    public static ClassLoader getClassLoader(ClassLoader parent, File file)
-            throws DeploymentException {
-        URLClassLoader classLoader;
-
-        if (file != null) {
-            try {
-                ArrayList urls = new ArrayList();
-
-                urls.add(file.toURL());
-
-                // lower case directory name
-                File libfiles = new File(file, "lib");
-
-                if (libfiles.exists()) {
-                    urls.add(libfiles.toURL());
-
-                    File jarfiles[] = libfiles.listFiles();
-
-                    for (int i = 0; i < jarfiles.length; i++) {
-                        File jarfile = jarfiles[i];
-
-                        if (jarfile.getName().endsWith(".jar")) {
-                            urls.add(jarfile.toURL());
-                        }
-                    }
-                }
-
-                // upper case directory name
-                libfiles = new File(file, "Lib");
-
-                if (libfiles.exists()) {
-                    urls.add(libfiles.toURL());
-
-                    File jarfiles[] = libfiles.listFiles();
-
-                    for (int i = 0; i < jarfiles.length; i++) {
-                        File jarfile = jarfiles[i];
-
-                        if (jarfile.getName().endsWith(".jar")) {
-                            urls.add(jarfile.toURL());
-                        }
-                    }
-                }
-
-                URL urllist[] = new URL[urls.size()];
-
-                for (int i = 0; i < urls.size(); i++) {
-                    urllist[i] = (URL) urls.get(i);
-                }
-
-                classLoader = new URLClassLoader(urllist, parent);
-
-                return classLoader;
-            } catch (MalformedURLException e) {
-                throw new DeploymentException(e);
-            }
-        }
-
-        return null;
-    }
-
-    private static Class getHandlerClass(String className, ClassLoader loader1) throws AxisFault {
-        Class handlerClass;
-
-        try {
-            handlerClass = Class.forName(className, true, loader1);
-        } catch (ClassNotFoundException e) {
-            throw new AxisFault(e.getMessage());
-        }
-
-        return handlerClass;
-    }
-
-    /**
-     * This guy will create a AxisService using java replection
-     */
-    public static void fillAxisService(AxisService axisService) throws Exception {
-        Parameter implInfoParam = axisService.getParameter(Constants.SERVICE_CLASS);
-        String serviceClass = (String) implInfoParam.getValue();
-        ClassLoader serviceClassLoader = axisService.getClassLoader();
-        SchemaGenerator schemaGenerator = new SchemaGenerator(serviceClassLoader,
-                serviceClass, null, null);
-        axisService.setSchema(schemaGenerator.generateSchema());
-
-        JMethod [] method = schemaGenerator.getMethods();
-        TypeTable table = schemaGenerator.getTypeTable();
-
-        for (int i = 0; i < method.length; i++) {
-            JMethod jmethod = method[i];
-            String opName = jmethod.getSimpleName();
-            AxisOperation operation = axisService.getOperation(new QName(opName));
-            if (operation != null) {
-                AxisMessage inMessage = operation.getMessage(
-                        WSDLConstants.MESSAGE_LABEL_IN_VALUE);
-                if (inMessage != null) {
-                    inMessage.setElementQName(table.getComplexScheamType(jmethod.getSimpleName() +
-                            SchemaGenerator.METHOD_REQUEST_WRAPPER));
-                }
-                if (!jmethod.getReturnType().isVoidType()) {
-                    AxisMessage outMessage = operation.getMessage(
-                            WSDLConstants.MESSAGE_LABEL_OUT_VALUE);
-                    outMessage.setElementQName(table.getQNamefortheType(jmethod.getSimpleName() +
-                            SchemaGenerator.METHOD_RESPONSE_WRAPPER));
-                }
-            }
-
-        }
-    }
-}
+package org.apache.axis2.deployment.util;
+
+import org.apache.axis2.AxisFault;
+import org.apache.axis2.Constants;
+import org.apache.axis2.deployment.DeploymentException;
+import org.apache.axis2.description.*;
+import org.apache.axis2.engine.Handler;
+import org.apache.axis2.wsdl.java2wsdl.SchemaGenerator;
+import org.apache.axis2.wsdl.java2wsdl.TypeTable;
+import org.apache.wsdl.WSDLConstants;
+import org.codehaus.jam.JMethod;
+
+import javax.xml.namespace.QName;
+import java.io.File;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+
+/*
+* Copyright 2004,2005 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.
+*
+*/
+
+public class Utils {
+    public static void addFlowHandlers(Flow flow, ClassLoader clsLoader) throws AxisFault {
+        int count = flow.getHandlerCount();
+
+        for (int j = 0; j < count; j++) {
+            HandlerDescription handlermd = flow.getHandler(j);
+            Class handlerClass;
+            Handler handler;
+
+            handlerClass = getHandlerClass(handlermd.getClassName(), clsLoader);
+
+            try {
+                handler = (Handler) handlerClass.newInstance();
+                handler.init(handlermd);
+                handlermd.setHandler(handler);
+            } catch (InstantiationException e) {
+                throw new AxisFault(e);
+            } catch (IllegalAccessException e) {
+                throw new AxisFault(e);
+            }
+        }
+    }
+
+    public static void loadHandler(ClassLoader loader1, HandlerDescription desc)
+            throws DeploymentException {
+        String handlername = desc.getClassName();
+        Handler handler;
+        Class handlerClass;
+
+        try {
+            handlerClass = Class.forName(handlername, true, loader1);
+            handler = (Handler) handlerClass.newInstance();
+            handler.init(desc);
+            desc.setHandler(handler);
+        } catch (ClassNotFoundException e) {
+            throw new DeploymentException(e);
+        } catch (Exception e) {
+            throw new DeploymentException(e);
+        }
+    }
+
+    public static ClassLoader getClassLoader(ClassLoader parent, String path)
+            throws DeploymentException {
+        return getClassLoader(parent, new File(path));
+    }
+    
+    public static ClassLoader getClassLoader(ClassLoader parent, File file)
+            throws DeploymentException {
+        URLClassLoader classLoader;
+
+        if (file != null) {
+            try {
+                ArrayList urls = new ArrayList();
+
+                urls.add(file.toURL());
+
+                // lower case directory name
+                File libfiles = new File(file, "lib");
+
+                if (libfiles.exists()) {
+                    urls.add(libfiles.toURL());
+
+                    File jarfiles[] = libfiles.listFiles();
+
+                    for (int i = 0; i < jarfiles.length; i++) {
+                        File jarfile = jarfiles[i];
+
+                        if (jarfile.getName().endsWith(".jar")) {
+                            urls.add(jarfile.toURL());
+                        }
+                    }
+                }
+
+                // upper case directory name
+                libfiles = new File(file, "Lib");
+
+                if (libfiles.exists()) {
+                    urls.add(libfiles.toURL());
+
+                    File jarfiles[] = libfiles.listFiles();
+
+                    for (int i = 0; i < jarfiles.length; i++) {
+                        File jarfile = jarfiles[i];
+
+                        if (jarfile.getName().endsWith(".jar")) {
+                            urls.add(jarfile.toURL());
+                        }
+                    }
+                }
+
+                URL urllist[] = new URL[urls.size()];
+
+                for (int i = 0; i < urls.size(); i++) {
+                    urllist[i] = (URL) urls.get(i);
+                }
+
+                classLoader = new URLClassLoader(urllist, parent);
+
+                return classLoader;
+            } catch (MalformedURLException e) {
+                throw new DeploymentException(e);
+            }
+        }
+
+        return null;
+    }
+
+    private static Class getHandlerClass(String className, ClassLoader loader1) throws AxisFault {
+        Class handlerClass;
+
+        try {
+            handlerClass = Class.forName(className, true, loader1);
+        } catch (ClassNotFoundException e) {
+            throw new AxisFault(e.getMessage());
+        }
+
+        return handlerClass;
+    }
+
+    /**
+     * Creates an AxisService using java reflection.
+     */
+    public static void fillAxisService(AxisService axisService) throws Exception {
+        Parameter implInfoParam = axisService.getParameter(Constants.SERVICE_CLASS);
+        String serviceClass = (String) implInfoParam.getValue();
+        ClassLoader serviceClassLoader = axisService.getClassLoader();
+        SchemaGenerator schemaGenerator = new SchemaGenerator(serviceClassLoader,
+                serviceClass, null, null);
+        axisService.setSchema(schemaGenerator.generateSchema());
+
+        JMethod [] method = schemaGenerator.getMethods();
+        TypeTable table = schemaGenerator.getTypeTable();
+
+        for (int i = 0; i < method.length; i++) {
+            JMethod jmethod = method[i];
+            String opName = jmethod.getSimpleName();
+            AxisOperation operation = axisService.getOperation(new QName(opName));
+            if (operation != null) {
+                AxisMessage inMessage = operation.getMessage(
+                        WSDLConstants.MESSAGE_LABEL_IN_VALUE);
+                if (inMessage != null) {
+                    inMessage.setElementQName(table.getComplexScheamType(jmethod.getSimpleName() +
+                            SchemaGenerator.METHOD_REQUEST_WRAPPER));
+                }
+                if (!jmethod.getReturnType().isVoidType()) {
+                    AxisMessage outMessage = operation.getMessage(
+                            WSDLConstants.MESSAGE_LABEL_OUT_VALUE);
+                    outMessage.setElementQName(table.getQNamefortheType(jmethod.getSimpleName() +
+                            SchemaGenerator.METHOD_RESPONSE_WRAPPER));
+                }
+            }
+
+        }
+    }
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAbstractFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAbstractFactory.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAbstractFactory.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAbstractFactory.java Wed Jan  4 11:45:13 2006
@@ -34,82 +34,82 @@
     }
 
     /**
-     * This will pick up the default factory implementation from the classpath
+     * Picks up the default factory implementation from the classpath.
      *
-     * @return
+     * @return Returns OMFactory.
      */
     public static OMFactory getOMFactory() {
         return FactoryFinder.findOMFactory(null);
     }
 
     /**
-     * If user needs to provide his own factory implementation, here provide the
-     * Class Loader for that.
+     * If user needs to provide his own factory implementation, provide the
+     * Class Loader here.
      *
      * @param classLoader
-     * @return
+     * @return Returns OMFactory.
      */
     public static OMFactory getOMFactory(ClassLoader classLoader) {
         return FactoryFinder.findOMFactory(classLoader);
     }
 
     /**
-     * This will pick up the provided <code>soapFactory</code> factory implementation from the classpath
+     * Gets the <code>soapFactory</code> factory implementation from the classpath
      *
      * @param soapFactory Fully qualified SOAP 1.1 or SOAP 1.2 Factory implementation class name
-     * @return The SOAP 1.1 or 1.2 Factory implementation instance corresponding to <code>soapFactory</code>
+     * @return Returns the SOAP 1.1 or 1.2 Factory implementation instance corresponding to <code>soapFactory</code>
      */
     public static SOAPFactory getSOAPFactory(String soapFactory) {
         return FactoryFinder.findSOAPFactory(null, soapFactory);
     }
 
     /**
-     * This will pick up the provided <code>soapFactory</code> factory implementation using the provided
+     * Gets the <code>soapFactory</code> factory implementation using the provided
      * <code>classLoader</code>
      *
      * @param classLoader
      * @param soapFactory Fully qualified SOAP 1.1 or SOAP 1.2 Factory implementation class name
-     * @return The SOAP 1.1 or 1.2 Factory implementation instance corresponding to <code>soapFactory</code>
+     * @return Returns the SOAP 1.1 or 1.2 Factory implementation instance corresponding to <code>soapFactory</code>
      */
     public static SOAPFactory getSOAPFactory(ClassLoader classLoader, String soapFactory) {
         return FactoryFinder.findSOAPFactory(classLoader, soapFactory);
     }
 
     /**
-     * This will pick up the default factory implementation from the classpath
+     * Gets the default factory implementation from the classpath.
      *
-     * @return
+     * @return Returns SOAPFactory.
      */
     public static SOAPFactory getSOAP11Factory() {
         return FactoryFinder.findSOAP11Factory(null);
     }
 
     /**
-     * If user needs to provide his own factory implementation, here provide the
-     * Class Loader for that.
+     * If user needs to provide his own factory implementation, provide the
+     * Class Loader here.
      *
      * @param classLoader
-     * @return
+     * @return Returns SOAPFactory.
      */
     public static SOAPFactory getSOAP11Factory(ClassLoader classLoader) {
         return FactoryFinder.findSOAP11Factory(classLoader);
     }
 
     /**
-     * This will pick up the default factory implementation from the classpath
+     * Gets the default factory implementation from the classpath.
      *
-     * @return
+     * @return Returns SOAPFactory.
      */
     public static SOAPFactory getSOAP12Factory() {
         return FactoryFinder.findSOAP12Factory(null);
     }
 
     /**
-     * If user needs to provide his own factory implementation, here provide the
-     * Class Loader for that.
+     * If user needs to provide his own factory implementation, provide the
+     * Class Loader here.
      *
      * @param classLoader
-     * @return
+     * @return Returns SOAPFactory.
      */
     public static SOAPFactory getSOAP12Factory(ClassLoader classLoader) {
         return FactoryFinder.findSOAP12Factory(classLoader);

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAttribute.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAttribute.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAttribute.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMAttribute.java Wed Jan  4 11:45:13 2006
@@ -23,7 +23,7 @@
  */
 public interface OMAttribute {
     /**
-     * @return localName
+     * @return Returns localName.
      */
     public String getLocalName();
 
@@ -33,7 +33,7 @@
     public void setLocalName(String localName);
 
     /**
-     * @return
+     * @return Returns String.
      */
     public String getAttributeValue();
 
@@ -48,12 +48,12 @@
     public void setOMNamespace(OMNamespace omNamespace);
 
     /**
-     * @return OMNamespace
+     * @return Returns OMNamespace.
      */
     public OMNamespace getNamespace();
 
     /**
-     * @return javax.xml.namespace.QName
+     * @return Returns javax.xml.namespace.QName
      */
     public QName getQName();
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMComment.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMComment.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMComment.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMComment.java Wed Jan  4 11:45:13 2006
@@ -22,7 +22,7 @@
 public interface OMComment extends OMNode {
     /**
      * Returns the value of this comment as defined by XPath 1.0.
-     * @return string
+     * @return Returns String.
      */
     public String getValue();
 

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMContainer.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMContainer.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMContainer.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMContainer.java Wed Jan  4 11:45:13 2006
@@ -28,10 +28,9 @@
 public interface OMContainer {
 
     /**
-     * This will add the given node as the last child.
-     *
-     * child to the element. One must preserve the order of children, in this operation
-     * Tip : appending the new child is prefered
+     * Adds the given node as the last child. One must preserve the order of children, 
+     * in this operation.
+     * Tip : appending the new child is preferred.
      *
      * @param omNode
      */
@@ -59,7 +58,7 @@
      * </p>
      *
      * @param elementQName The QName specifying namespace and local name to match.
-     * @return An iterator of {@link OMElement} items that match the given QName appropriately.
+     * @return Returns an iterator of {@link OMElement} items that match the given QName appropriately.
      */
     public Iterator getChildrenWithName(QName elementQName);
 
@@ -70,7 +69,7 @@
      *
      * @param elementQName The QName to use for matching.
      *
-     * @return The first element in document order that matches the <tt>elementQName</tt> criteria.
+     * @return Returns the first element in document order that matches the <tt>elementQName</tt> criteria.
      *
      * @see #getChildrenWithName
      *
@@ -89,7 +88,7 @@
     public Iterator getChildren();
 
     /**
-     * Get the first child.
+     * Gets the first child.
      *
      * @return Returns the first child.  May return null if the container has no children.
      */

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocType.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocType.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocType.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocType.java Wed Jan  4 11:45:13 2006
@@ -21,8 +21,8 @@
  */
 public interface OMDocType extends OMNode {
     /**
-     * Returns the value of this DocType
-     * @return string
+     * Returns the value of this DocType.
+     * @return Returns String.
      */
     public String getValue();
 

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMDocument.java Wed Jan  4 11:45:13 2006
@@ -33,25 +33,25 @@
     public final static String XML_11 = "1.1";
 
     /**
-     * Returns the document element
-     * @return
+     * Returns the document element.
+     * @return Returns OMElement.
      */
     public OMElement getOMDocumentElement();
 
     /**
-     * Sets the document element of the XML document
+     * Sets the document element of the XML document.
      * @param rootElement
      */
     public void setOMDocumentElement(OMElement rootElement);
 
     /**
-     * Returns the XML version
-     * @return
+     * Returns the XML version.
+     * @return Returns String.
      */
     public String getXMLVersion();
 
     /**
-     * Sets the XML version
+     * Sets the XML version.
      * @see org.apache.axis2.om.impl.llom.OMDocumentImpl#XML_10 XML 1.0
      * @see org.apache.axis2.om.impl.llom.OMDocumentImpl#XML_11 XML 1.1
      * @param version
@@ -59,27 +59,27 @@
     public void setXMLVersion(String version);
 
     /**
-     * Returns the caracter set encoding scheme
-     * @return
+     * Returns the character set encoding scheme.
+     * @return Returns String.
      */
     public String getCharsetEncoding();
 
     /**
-     * Sets the character set encoding scheme to be used
+     * Sets the character set encoding scheme to be used.
      * @param charsetEncoding
      */
     public void setCharsetEncoding(String charsetEncoding);
 
     /**
-     * XML standalone value
+     * XML standalone value.
      * This will be yes, no or null (if not available)
-     * @return boolean
+     * @return Returns boolean.
      */
     public String isStandalone();
     public void setStandalone(String isStandalone);
 
     /**
-     * Serialize the OMDocument
+     * Serializes the OMDocument.
      * @param output
      * @param format
      * @throws XMLStreamException
@@ -87,7 +87,7 @@
     public void serializeAndConsume(OutputStream output, OMOutputFormat format) throws XMLStreamException;
 
     /**
-     * Serializa the document with cache on
+     * Builds the OM node/tree and then serializes the document.
      * @param output
      * @param format
      * @throws XMLStreamException
@@ -95,14 +95,14 @@
     public void serialize(OutputStream output, OMOutputFormat format) throws XMLStreamException;
 
     /**
-     * Serialize the OMDocument
+     * Serializes the OMDocument.
      * @param output
      * @throws XMLStreamException
      */
     public void serializeAndConsume(OutputStream output) throws XMLStreamException;
 
     /**
-     * Serializa the document with cache on
+     * Serializes the document with cache on.
      * @param output
      * @throws XMLStreamException
      */

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMElement.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMElement.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMElement.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMElement.java Wed Jan  4 11:45:13 2006
@@ -25,7 +25,6 @@
  * A particular kind of node that represents an element infoset information item.
  * <p/>
  * <p>An element has a collection of children, attributes, and namespaces.</p>
- * <p/>
  * <p>In contrast with DOM, this interface exposes namespaces separately from the
  * attributes.</p>
  */
@@ -34,20 +33,20 @@
     /**
      * Returns a filtered list of children - just the elements.
      *
-     * @return an iterator over the child elements
+     * @return Returns an iterator over the child elements.
      * @see #getChildren()
      * @see #getChildrenWithName(javax.xml.namespace.QName)
      */
     public Iterator getChildElements();
 
     /**
-     * THis will create a namespace in the current element scope
+     * Creates a namespace in the current element scope.
      *
      * @param uri    The namespace to declare in the current scope.  The
      *               caller is expected to ensure that the URI is a valid namespace name.
      * @param prefix The prefix to associate with the given namespace.
      *               The caller is expected to ensure that this is a valid XML prefix.
-     * @return The created namespace information item.
+     * @return Returns the created namespace information item.
      * @see #declareNamespace(OMNamespace)
      * @see #findNamespace(String, String)
      * @see #getAllDeclaredNamespaces()
@@ -55,10 +54,10 @@
     public OMNamespace declareNamespace(String uri, String prefix);
 
     /**
-     * Declare a namespace with the element as its scope.
+     * Declares a namespace with the element as its scope.
      *
      * @param namespace The namespace to declare
-     * @return The namespace parameter passed.
+     * @return Returns the namespace parameter passed.
      * @see #declareNamespace(String, String)
      * @see #findNamespace(String, String)
      * @see #getAllDeclaredNamespaces()
@@ -66,17 +65,17 @@
     public OMNamespace declareNamespace(OMNamespace namespace);
 
     /**
-     * This will find a namespace with the given uri and prefix, in the scope of the hierarchy.
+     * Finds a namespace with the given uri and prefix, in the scope of the hierarchy.
      * <p/>
-     * <p>This will search from the current element and go up the hiararchy until a match is found.
-     * If no match is found, return <tt>null</tt>.</p>
+     * <p>Searches from the current element and goes up the hiararchy until a match is found.
+     * If no match is found, returns <tt>null</tt>.</p>
      * <p/>
      * <p>Either <tt>prefix</tt> or <tt>uri</tt> should be null.  Results are undefined
      * if both are specified.</p>
      *
      * @param uri    The namespace to look for.  If this is specified, <tt>prefix</tt> should be null.
      * @param prefix The prefix to look for.  If this is specified, <tt>uri</tt> should be null.
-     * @return The matching namespace declaration, or <tt>null</tt> if none was found.
+     * @return Returns the matching namespace declaration, or <tt>null</tt> if none was found.
      * @see #declareNamespace(String, String)
      * @see #declareNamespace(OMNamespace)
      * @see #getAllDeclaredNamespaces()
@@ -84,8 +83,8 @@
     public OMNamespace findNamespace(String uri, String prefix);
 
     /**
-     * This will check for a namespace in the context of this element with the given prefix and
-     * will return the relevant namespace object, if available. If not available, will return null.
+     * Checks for a namespace in the context of this element with the given prefix and
+     * returns the relevant namespace object, if available. If not available, returns null.
      *
      * @param prefix
      */
@@ -99,7 +98,7 @@
      * any call to either <tt>declareNamespace</tt> function.
      * </p>
      *
-     * @return An iterator over the {@link OMNamespace} items declared on the current element.
+     * @return Returns an iterator over the {@link OMNamespace} items declared on the current element.
      * @see #findNamespace(String, String)
      * @see #declareNamespace(String, String)
      * @see #declareNamespace(OMNamespace)
@@ -107,8 +106,8 @@
     public Iterator getAllDeclaredNamespaces() throws OMException;
 
     /**
-     * This will return a List of OMAttributes.
-     * <p/>
+     * Returns a list of OMAttributes.
+     * 
      * <p>Note that the iterator returned by this function will be invalidated by
      * any <tt>addAttribute</tt> call.
      * </p>
@@ -121,33 +120,33 @@
     public Iterator getAllAttributes();
 
     /**
-     * Return a named attribute if present.
+     * Returns a named attribute if present.
      *
      * @param qname the qualified name to search for
-     * @return an OMAttribute with the given name if found, or null
+     * @return Returns an OMAttribute with the given name if found, or null
      */
     public OMAttribute getAttribute(QName qname);
 
     /**
-     * Return a named attribute's value, if present.
+     * Returns a named attribute's value, if present.
      *
      * @param qname the qualified name to search for
-     * @return a String containing the attribute value, or null
+     * @return Returns a String containing the attribute value, or null
      */
     public String getAttributeValue(QName qname);
 
     /**
-     * This will add an attribute to this element.
+     * Adds an attribute to this element.
      * <p/>
      * <p>There is no order implied by added attributes.</p>
      *
      * @param attr The attribute to add.
-     * @return The passed in attribute.
+     * @return Returns the passed in attribute.
      */
     public OMAttribute addAttribute(OMAttribute attr);
 
     /**
-     * Add an attribute to the current element.
+     * Adds an attribute to the current element.
      * <p/>
      * <p>This function does not check to make sure that the given attribute value can be serialized directly
      * as an XML value.  The caller may, for example, pass a string with the character 0x01.
@@ -156,7 +155,7 @@
      * @param value         The string value of the attribute.
      * @param ns            The namespace has to be one of the in scope namespace. i.e. the passed namespace
      *                      must be declared in the parent element of this attribute or ancestors of the parent element of the attribute.
-     * @return The added attribute.
+     * @return Returns the added attribute.
      */
     public OMAttribute addAttribute(String attributeName, String value,
                                     OMNamespace ns);
@@ -169,7 +168,7 @@
     public void removeAttribute(OMAttribute attr);
 
     /**
-     * Method setBuilder
+     * Method setBuilder.
      *
      * @param wrapper
      */
@@ -178,12 +177,12 @@
     /**
      * Returns the builder object.
      *
-     * @return The builder object used to construct the underlying XML infoset on the fly.
+     * @return Returns the builder object used to construct the underlying XML infoset on the fly.
      */
     public OMXMLParserWrapper getBuilder();
 
     /**
-     * Set the first child
+     * Sets the first child.
      *
      * @param node
      */
@@ -192,7 +191,7 @@
     /**
      * Returns the first child element of the element.
      *
-     * @return The first child element of the element, or <tt>null</tt> if none was found.
+     * @return Returns the first child element of the element, or <tt>null</tt> if none was found.
      */
 
     public OMElement getFirstElement();
@@ -204,7 +203,7 @@
      * <p/>
      * <p>Caching is on.</p>
      *
-     * @return Return an XMLStreamReader relative to this element.
+     * @return Returns an XMLStreamReader relative to this element.
      */
     public XMLStreamReader getXMLStreamReader();
 
@@ -214,7 +213,7 @@
      * <p/>
      * <p>Caching is off.</p>
      *
-     * @return Return an XMLStreamReader relative to this element, with no caching.
+     * @return Returns an XMLStreamReader relative to this element, with no caching.
      */
     public XMLStreamReader getXMLStreamReaderWithoutCaching();
 
@@ -224,16 +223,16 @@
     public void setText(String text);
 
     /**
-     * This will return the non-empty text children as a String
+     * Returns the non-empty text children as a String.
      *
-     * @return A String representing the concatenation of the child text nodes.
+     * @return Returns a String representing the concatenation of the child text nodes.
      */
     public String getText();
 
     /**
      * Returns the local name of the element.
      *
-     * @return The local name of the element.
+     * @return Returns the local name of the element.
      */
     public String getLocalName();
 
@@ -245,22 +244,22 @@
     public void setLocalName(String localName);
 
     /**
-     * @return the OMNamespace object associated with this element
+     * @return Returns the OMNamespace object associated with this element
      * @throws OMException
      */
     public OMNamespace getNamespace() throws OMException;
 
     /**
-     * sets the Namespace
+     * Sets the Namespace.
      *
      * @param namespace
      */
     public void setNamespace(OMNamespace namespace);
 
     /**
-     * Get the QName of this node
+     * Gets the QName of this node.
      *
-     * @return The {@link QName} for the element.
+     * @return Returns the {@link QName} for the element.
      */
     public QName getQName();
 
@@ -271,7 +270,7 @@
     public String toString();
 
     /**
-     * This is a convenience method only. This will basically serialize the given OMElement
+     * This is a convenience method only. This basically serializes the given OMElement
      * to a String but will NOT build the OMTree in the memory. So you are at your own risk of
      * losing information.
      */
@@ -279,18 +278,18 @@
 
 
     /**
-     * Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context
-     * unprefixed qnames resolve to the local namespace
+     * Turns a prefix:local qname string into a proper QName, evaluating it in the OMElement context.
+     * Unprefixed qnames resolve to the local namespace.
      *
      * @param qname prefixed qname string to resolve
-     * @return null for any failure to extract a qname.
+     * @return Returns null for any failure to extract a qname.
      */
     QName resolveQName(String qname);
 
     /**
-     * This method will clone this element. But both elements will be build compleletely. So you will
+     * Clones this element. Since both elements are build compleletely, you will
      * lose the differed building capability.
-     * @return
+     * @return Returns OMElement.
      */
     public OMElement cloneOMElement();
 

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMFactory.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMFactory.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMFactory.java Wed Jan  4 11:45:13 2006
@@ -24,7 +24,7 @@
 public interface OMFactory {
 
 	/**
-	 * Create a new OMDocument
+	 * Creates a new OMDocument.
 	 */
 	public OMDocument createOMDocument();
 	public OMDocument createOMDocument(OMXMLParserWrapper builder);
@@ -56,7 +56,7 @@
      * @param localName
      * @param namespaceURI
      * @param namespacePrefix
-     * @return
+     * @return Returns the newly created OMElement.
      */
     public OMElement createOMElement(String localName,
                                      String namespaceURI,
@@ -69,7 +69,7 @@
      *
      * @param qname
      * @param parent
-     * @return
+     * @return Returns the new OMElement.
      * @throws OMException
      */
     public OMElement createOMElement(QName qname, OMContainer parent)
@@ -78,14 +78,14 @@
     /**
      * @param uri
      * @param prefix
-     * @return
+     * @return Returns OMNameSpace.
      */
     public OMNamespace createOMNamespace(String uri, String prefix);
 
     /**
      * @param parent
      * @param text
-     * @return
+     * @return Returns OMText.
      */
     public OMText createText(OMElement parent, String text);
 
@@ -95,13 +95,13 @@
      * @param text
      * @param type - this should be either of XMLStreamConstants.CHARACTERS, XMLStreamConstants.CDATA,
      * XMLStreamConstants.SPACE, XMLStreamConstants.ENTITY_REFERENCE
-     * @return
+     * @return Returns OMText.
      */
     public OMText createText(OMElement parent, String text, int type);
 
     /**
      * @param s
-     * @return
+     * @return Returns OMText.
      */
     public OMText createText(String s);
 
@@ -110,8 +110,8 @@
      * @param s
      * @param type - OMText node can handle SPACE, CHARACTERS, CDATA and ENTITY REFERENCES. For Constants, use either
      * XMLStreamConstants or constants found in OMNode.
-     * @return
-     */
+     * @return Returns OMText.
+     */ 
     public OMText createText(String s, int type);
 
     public OMText createText(String s, String mimeType, boolean optimize);
@@ -129,27 +129,27 @@
                                          String value);
 
     /**
-     * create DocType/DTD
+     * Creates DocType/DTD.
      * @param parent
      * @param content
-     * @return doctype
+     * @return Returns doctype.
      */
     public OMDocType createOMDocType(OMContainer parent, String content);
 
     /**
-     * create a PI
+     * Creates a PI.
      * @param parent
      * @param piTarget
      * @param piData
-     * @return pi
+     * @return Returns OMProcessingInstruction.
      */
     public OMProcessingInstruction createOMProcessingInstruction(OMContainer parent, String piTarget, String piData);
 
     /**
-     * create a comment
+     * Creates a comment.
      * @param parent
      * @param content
-     * @return comment
+     * @return Returns OMComment.
      */
     public OMComment createOMComment(OMContainer parent, String content);
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNamespace.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNamespace.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNamespace.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNamespace.java Wed Jan  4 11:45:13 2006
@@ -21,25 +21,25 @@
  */
 public interface OMNamespace {
     /**
-     * Method equals
+     * Method equals.
      *
      * @param uri
      * @param prefix
-     * @return
+     * @return Returns boolean.
      */
     public boolean equals(String uri, String prefix);
 
     /**
-     * Method getPrefix
+     * Method getPrefix.
      *
-     * @return
+     * @return Returns String.
      */
     public String getPrefix();
 
     /**
-     * Method getName
+     * Method getName.
      *
-     * @return
+     * @return Returns String.
      */
     public String getName();
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNode.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNode.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNode.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMNode.java Wed Jan  4 11:45:13 2006
@@ -23,7 +23,7 @@
 import java.io.Writer;
 
 /**
- * Defines the the base interface used by most of the XML object model within Axis.
+ * Defines the base interface used by most of the XML object model within Axis.
  *
  * <p>This tree model for XML captures the idea of deferring the construction of child nodes
  * until they are needed.  The <code>isComplete</code> function identifies whether or not
@@ -79,14 +79,14 @@
     public static final short PI_NODE = XMLStreamConstants.PROCESSING_INSTRUCTION;
 
     /**
-     * This node is a <code>Entity Reference</code>.
+     * This node is an <code>Entity Reference</code>.
      *
      * @see #getType()
      */
     public static final short ENTITY_REFERENCE_NODE = XMLStreamConstants.ENTITY_REFERENCE;
 
     /**
-     * This node is a <code>Entity Reference</code>.
+     * This node is an <code>Entity Reference</code>.
      *
      * @see #getType()
      */
@@ -104,16 +104,16 @@
     /**
      * Returns the next sibling in document order.
      *
-     * @return The next sibling in document order.
+     * @return Returns the next sibling in document order.
      */
     public OMNode getNextOMSibling() throws OMException;
 
     /**
-     * this will indicate whether parser has parsed this information item completely or not.
-     * If somethings info are not available in the item, one has to check this attribute to make sure that, this
+     * Indicates whether parser has parsed this information item completely or not.
+     * If some info are not available in the item, one has to check this attribute to make sure that, this
      * item has been parsed completely or not.
      *
-     * @return boolean
+     * @return Returns boolean.
      */
     public boolean isComplete();
 
@@ -153,7 +153,7 @@
     public void insertSiblingAfter(OMNode sibling) throws OMException;
 
     /**
-     * This will insert a sibling just before the current node.
+     * Inserts a sibling just before the current node.
      *
      * @param sibling The node that will be added before the current node.
      * @throws OMException
@@ -163,21 +163,21 @@
     /**
      * Returns the type of node.
      *
-     * @return One of {@link #ELEMENT_NODE}, {@link #TEXT_NODE}, {@link #CDATA_SECTION_NODE}, {@link #COMMENT_NODE},
+     * @return Returns one of {@link #ELEMENT_NODE}, {@link #TEXT_NODE}, {@link #CDATA_SECTION_NODE}, {@link #COMMENT_NODE},
      *  {@link #DTD_NODE}, {@link #PI_NODE}, {@link #ENTITY_REFERENCE_NODE}, {@link #SPACE_NODE},
      * or {@link #TEXT_NODE}.
      */
     public int getType();
 
     /**
-     * get the previous sibling
+     * Gets the previous sibling.
      *
-     * @return node
+     * @return Returns node.
      */
     public OMNode getPreviousOMSibling();
 
     /**
-     * Serialize the node with caching
+     * Serializes the node with caching.
      *
      * @param xmlWriter
      * @throws XMLStreamException
@@ -186,7 +186,7 @@
             throws XMLStreamException;
 
     /**
-     * Serialize the node with caching
+     * Serializes the node with caching.
      *
      * @param output
      * @throws XMLStreamException
@@ -195,7 +195,7 @@
             throws XMLStreamException;
 
     /**
-     * Serialize the node with caching
+     * Serializes the node with caching.
      *
      * @param writer
      * @throws XMLStreamException
@@ -204,7 +204,7 @@
             throws XMLStreamException;
 
     /**
-     * Serialize the node with caching
+     * Serializes the node with caching.
      *
      * @param output
      * @param format
@@ -214,7 +214,7 @@
             throws XMLStreamException;
 
     /**
-     * Serialize the node with caching
+     * Serializes the node with caching.
      *
      * @param writer
      * @param format
@@ -224,7 +224,7 @@
             throws XMLStreamException;
     
     /**
-     * Serialize the node without caching
+     * Serializes the node without caching.
      *
      * @param xmlWriter
      * @throws XMLStreamException
@@ -232,7 +232,7 @@
     public void serializeAndConsume(XMLStreamWriter xmlWriter) throws XMLStreamException;
 
     /**
-     * Serialize the node without caching
+     * Serializes the node without caching.
      *
      * @param output
      * @throws XMLStreamException
@@ -240,7 +240,7 @@
     public void serializeAndConsume(OutputStream output) throws XMLStreamException;
 
     /**
-     * Serialize the node without caching
+     * Serializes the node without caching.
      *
      * @param writer
      * @throws XMLStreamException
@@ -248,7 +248,7 @@
     public void serializeAndConsume(Writer writer) throws XMLStreamException;
 
     /**
-     * Serialize the node without caching
+     * Serializes the node without caching.
      *
      * @param output
      * @param format
@@ -257,7 +257,7 @@
     public void serializeAndConsume(OutputStream output, OMOutputFormat format) throws XMLStreamException;
 
     /**
-     * Serialize the node without caching
+     * Serializes the node without caching.
      *
      * @param writer
      * @param format
@@ -266,7 +266,7 @@
     public void serializeAndConsume(Writer writer, OMOutputFormat format) throws XMLStreamException;
 
     /**
-     * Builds itself
+     * Builds itself.
      */
     public void build();
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMOutputFormat.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMOutputFormat.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMOutputFormat.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMOutputFormat.java Wed Jan  4 11:45:13 2006
@@ -1,142 +1,142 @@
-/*
- * Copyright 2004,2005 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.
- */
-
-package org.apache.axis2.om;
-
-import org.apache.axis2.om.impl.MIMEOutputUtils;
-import org.apache.axis2.soap.SOAP11Constants;
-import org.apache.axis2.soap.SOAP12Constants;
-import org.apache.axis2.util.UUIDGenerator;
-
-
-/**
- * Format options for OM Output
- */
-public class OMOutputFormat {
-    private String mimeBoundary = null;
-    private String rootContentId = null;
-    private int nextid = 0;
-    private boolean doOptimize;
-    private boolean isSoap11 = true;
-
-    /**
-     * Field DEFAULT_CHAR_SET_ENCODING specifies the default
-     * character encoding scheme to be used
-     */
-    public static final String DEFAULT_CHAR_SET_ENCODING = "utf-8";
-
-    private String charSetEncoding;
-    private String xmlVersion;
-    private boolean ignoreXMLDeclaration = false;
-
-
-    public OMOutputFormat() {
-    }
-
-    public boolean isOptimized() {
-        return doOptimize;
-    }
-
-    public String getContentType() {
-        String SOAPContentType;
-        if (isOptimized()) {
-            if (isSoap11) {
-                SOAPContentType = SOAP11Constants.SOAP_11_CONTENT_TYPE;
-            } else {
-                SOAPContentType = SOAP12Constants.SOAP_12_CONTENT_TYPE;
-            }
-            return MIMEOutputUtils.getContentTypeForMime(
-                    getMimeBoundary(),
-                    getRootContentId(),
-                    this.getCharSetEncoding(), SOAPContentType);
-        } else {
-            if (!isSoap11) {
-                return SOAP12Constants.SOAP_12_CONTENT_TYPE;
-            } else {
-                return SOAP11Constants.SOAP_11_CONTENT_TYPE;
-            }
-        }
-    }
-
-    public String getMimeBoundary() {
-        if (mimeBoundary == null) {
-            mimeBoundary =
-                    "MIMEBoundary"
-                            + UUIDGenerator.getUUID();
-        }
-        return mimeBoundary;
-    }
-
-    public String getRootContentId() {
-        if (rootContentId == null) {
-            rootContentId =
-                    "0."
-                            + UUIDGenerator.getUUID()
-                            + "@apache.org";
-        }
-        return rootContentId;
-    }
-
-    public String getNextContentId() {
-        nextid++;
-        return nextid
-                + "."
-                + UUIDGenerator.getUUID()
-                + "@apache.org";
-    }
-
-    /**
-     * Returns the character set endocing scheme If the value of the
-     * charSetEncoding is not set then the default will be returned
-     *
-     * @return encoding
-     */
-    public String getCharSetEncoding() {
-        return this.charSetEncoding;
-    }
-
-    public void setCharSetEncoding(String charSetEncoding) {
-        this.charSetEncoding = charSetEncoding;
-    }
-
-    public String getXmlVersion() {
-        return xmlVersion;
-    }
-
-    public void setXmlVersion(String xmlVersion) {
-        this.xmlVersion = xmlVersion;
-    }
-
-    public void setSOAP11(boolean b) {
-        isSoap11 = b;
-    }
-    
-    public boolean isSOAP11() {
-        return isSoap11;
-    }
-
-    public boolean isIgnoreXMLDeclaration() {
-        return ignoreXMLDeclaration;
-    }
-
-    public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration) {
-        this.ignoreXMLDeclaration = ignoreXMLDeclaration;
-    }
-
-    public void setDoOptimize(boolean b) {
-        doOptimize = b;
-    }
-}
+/*
+ * Copyright 2004,2005 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.
+ */
+
+package org.apache.axis2.om;
+
+import org.apache.axis2.om.impl.MIMEOutputUtils;
+import org.apache.axis2.soap.SOAP11Constants;
+import org.apache.axis2.soap.SOAP12Constants;
+import org.apache.axis2.util.UUIDGenerator;
+
+
+/**
+ * Formats options for OM Output.
+ */
+public class OMOutputFormat {
+    private String mimeBoundary = null;
+    private String rootContentId = null;
+    private int nextid = 0;
+    private boolean doOptimize;
+    private boolean isSoap11 = true;
+
+    /**
+     * Field DEFAULT_CHAR_SET_ENCODING. Specifies the default
+     * character encoding scheme to be used.
+     */
+    public static final String DEFAULT_CHAR_SET_ENCODING = "utf-8";
+
+    private String charSetEncoding;
+    private String xmlVersion;
+    private boolean ignoreXMLDeclaration = false;
+
+
+    public OMOutputFormat() {
+    }
+
+    public boolean isOptimized() {
+        return doOptimize;
+    }
+
+    public String getContentType() {
+        String SOAPContentType;
+        if (isOptimized()) {
+            if (isSoap11) {
+                SOAPContentType = SOAP11Constants.SOAP_11_CONTENT_TYPE;
+            } else {
+                SOAPContentType = SOAP12Constants.SOAP_12_CONTENT_TYPE;
+            }
+            return MIMEOutputUtils.getContentTypeForMime(
+                    getMimeBoundary(),
+                    getRootContentId(),
+                    this.getCharSetEncoding(), SOAPContentType);
+        } else {
+            if (!isSoap11) {
+                return SOAP12Constants.SOAP_12_CONTENT_TYPE;
+            } else {
+                return SOAP11Constants.SOAP_11_CONTENT_TYPE;
+            }
+        }
+    }
+
+    public String getMimeBoundary() {
+        if (mimeBoundary == null) {
+            mimeBoundary =
+                    "MIMEBoundary"
+                            + UUIDGenerator.getUUID();
+        }
+        return mimeBoundary;
+    }
+
+    public String getRootContentId() {
+        if (rootContentId == null) {
+            rootContentId =
+                    "0."
+                            + UUIDGenerator.getUUID()
+                            + "@apache.org";
+        }
+        return rootContentId;
+    }
+
+    public String getNextContentId() {
+        nextid++;
+        return nextid
+                + "."
+                + UUIDGenerator.getUUID()
+                + "@apache.org";
+    }
+
+    /**
+     * Returns the character set encoding scheme. If the value of the
+     * charSetEncoding is not set then the default will be returned.
+     *
+     * @return Returns encoding string.
+     */
+    public String getCharSetEncoding() {
+        return this.charSetEncoding;
+    }
+
+    public void setCharSetEncoding(String charSetEncoding) {
+        this.charSetEncoding = charSetEncoding;
+    }
+
+    public String getXmlVersion() {
+        return xmlVersion;
+    }
+
+    public void setXmlVersion(String xmlVersion) {
+        this.xmlVersion = xmlVersion;
+    }
+
+    public void setSOAP11(boolean b) {
+        isSoap11 = b;
+    }
+    
+    public boolean isSOAP11() {
+        return isSoap11;
+    }
+
+    public boolean isIgnoreXMLDeclaration() {
+        return ignoreXMLDeclaration;
+    }
+
+    public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration) {
+        this.ignoreXMLDeclaration = ignoreXMLDeclaration;
+    }
+
+    public void setDoOptimize(boolean b) {
+        doOptimize = b;
+    }
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMProcessingInstruction.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMProcessingInstruction.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMProcessingInstruction.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMProcessingInstruction.java Wed Jan  4 11:45:13 2006
@@ -21,26 +21,26 @@
  */
 public interface OMProcessingInstruction extends OMNode {
     /**
-     * set the target of this PI
+     * Sets the target of this Processing Instruction.
      * @param target
      */
     public void setTarget(String target);
 
     /**
-     * get the target of this PI
-      * @return string
+     * Gets the target of this Processing Instruction.
+      * @return Returns string.
      */
     public String getTarget();
 
     /**
-     * set the value of this PI
+     * Sets the value of this Processing Instruction.
      * @param value
      */
     public void setValue(String value);
 
     /**
-     * get the value of this PI
-      * @return string
+     * Gets the value of this Processing Instruction.
+      * @return Returns String.
      */
     public String getValue();
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMText.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMText.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMText.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMText.java Wed Jan  4 11:45:13 2006
@@ -22,33 +22,33 @@
  */
 public interface OMText extends OMNode {
     /**
-     * Returns the text value of this node
+     * Returns the text value of this node.
      *
-     * @return string
+     * @return Returns String.
      */
     String getText();
 
     /**
-     * get the datahandler
-     * @return datahandler
+     * Gets the datahandler.
+     * @return Returns datahandler.
      */
     Object getDataHandler();
 
     /**
-     * @return boolean flag saying whether the node contains
-     *         an optimized text or not
+     * @return Returns boolean flag saying whether the node contains
+     *         an optimized text or not.
      */
     boolean isOptimized();
 
     /**
-     * set the optimize flag
+     * Sets the optimize flag.
      * @param value
      */
     void setOptimize(boolean value);
 
     /**
-     * get the content id
-     * @return string
+     * Gets the content id.
+     * @return Returns String.
      */
     String getContentID();
-}
\ No newline at end of file
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMXMLParserWrapper.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMXMLParserWrapper.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMXMLParserWrapper.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/OMXMLParserWrapper.java Wed Jan  4 11:45:13 2006
@@ -21,9 +21,9 @@
  */
 public interface OMXMLParserWrapper {
     /**
-     * Proceed the parser one step and return the event value
+     * Proceed the parser one step and return the event value.
      *
-     * @return
+     * @return Returns int.
      * @throws org.apache.axis2.om.OMException
      *
      * @throws OMException
@@ -31,8 +31,8 @@
     int next() throws OMException;
 
     /**
-     * Discard the current element
-     * This should remove the given element and its decendants.
+     * Discards the current element.
+     * This will remove the given element and its decendants.
      *
      * @param el
      * @throws org.apache.axis2.om.OMException
@@ -51,37 +51,36 @@
 
     /**
      * Allows to access the underlying parser. Since the parser
-     * depends on the underlying implementation,an Object is returned
+     * depends on the underlying implementation, an Object is returned.
      * However the implementations may have restrictions in letting access to
-     * the parser
+     * the parser.
      *
-     * @return
+     * @return Returns Object.
      */
     Object getParser();
 
     /**
-     * @return the complete status
+     * @return Returns the complete status.
      */
     boolean isCompleted();
 
     /**
-     * @return the document element
+     * @return Returns the document element.
      */
     OMElement getDocumentElement();
 
     /**
      * Returns the type of the builder.
-     * Can be either the
-     * PUSH_TYPE_BUILDER or PULL_TYPE_BUILDER
+     * Can be either PUSH_TYPE_BUILDER or PULL_TYPE_BUILDER.
      *
-     * @return
+     * @return Returns short.
      */
     short getBuilderType();
 
     /**
      * Registers an external content handler. Especially useful for
-     * push type builders. will throw an unsupportedOperationExcveption if
-     * such handler registration is not supported
+     * push type builders. Throws an unsupportedOperationException if
+     * such handler registration is not supported.
      *
      * @param obj
      */
@@ -90,7 +89,7 @@
     /**
      * get the registered external content handler
      *
-     * @return
+     * @return Returns Object.
      */
     Object getRegisteredContentHandler();
 }

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MIMEOutputUtils.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MIMEOutputUtils.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MIMEOutputUtils.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MIMEOutputUtils.java Wed Jan  4 11:45:13 2006
@@ -98,9 +98,9 @@
     }
 
     /**
-     * this will write a CRLF for the earlier boudary then the BodyPart data
+     * Writes a CRLF for the earlier boundary then the BodyPart data
      * with headers followed by boundary. Writes only the boundary. No more
-     * CRLF's are wriiting after that.
+     * CRLF's are written after that.
      *
      * @throws IOException
      * @throws MessagingException
@@ -137,4 +137,4 @@
         sb.append("start-info=\""+SOAPContentType+"\"");
         return sb.toString();
     }
-}
\ No newline at end of file
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MTOMConstants.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MTOMConstants.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MTOMConstants.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/MTOMConstants.java Wed Jan  4 11:45:13 2006
@@ -21,11 +21,11 @@
     public static final String XOP_NAMESPACE_URI = "http://www.w3.org/2004/08/xop/include";
 
     /**
-     * if the Message is MTOM optimised then <code>MTOM_TYPE</code>
+     * If the Message is MTOM optimised then <code>MTOM_TYPE</code>
      */
     String MTOM_TYPE = "application/xop+xml";
     /**
-     * If the message is Soap with Attachments <code>SwA_TYPE</code>
+     * If the message is Soap with Attachments <code>SWA_TYPE</code>
      */
     String SWA_TYPE = "text/xml";
     /**

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMContainerEx.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMContainerEx.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMContainerEx.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMContainerEx.java Wed Jan  4 11:45:13 2006
@@ -1,32 +1,32 @@
-/*
- * Copyright 2004,2005 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.
- */
-
-package org.apache.axis2.om.impl;
-
-import org.apache.axis2.om.OMContainer;
-import org.apache.axis2.om.OMNode;
-
-/**
- * Interface OMContainerEx
- *
- * Internal Implementation detail. Adding special interface to stop folks from accidently using OMContainer.
- * Please use at your own risk. May corrupt the data integrity
- */
-public interface OMContainerEx extends OMContainer {
-    public void setComplete(boolean state);
-
-    public void setFirstChild(OMNode omNode);
-}
+/*
+ * Copyright 2004,2005 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.
+ */
+
+package org.apache.axis2.om.impl;
+
+import org.apache.axis2.om.OMContainer;
+import org.apache.axis2.om.OMNode;
+
+/**
+ * Interface OMContainerEx
+ *
+ * Internal Implementation detail. Adding special interface to stop folks from accidently using OMContainer.
+ * Please use at your own risk. May corrupt the data integrity.
+ */
+public interface OMContainerEx extends OMContainer {
+    public void setComplete(boolean state);
+
+    public void setFirstChild(OMNode omNode);
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMNodeEx.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMNodeEx.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMNodeEx.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMNodeEx.java Wed Jan  4 11:45:13 2006
@@ -1,59 +1,59 @@
-/*
- * Copyright 2004,2005 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.
- */
-
-package org.apache.axis2.om.impl;
-
-import org.apache.axis2.om.OMContainer;
-import org.apache.axis2.om.OMException;
-import org.apache.axis2.om.OMNode;
-
-import javax.xml.stream.XMLStreamException;
-
-/**
- * Interface OMNodeEx
- *
- * Internal Implementation detail. Adding special interface to stop folks from accidently using OMNode.
- * Please use at your own risk. May corrupt the data integrity
- */
-public interface OMNodeEx extends OMNode {
-    public void setNextOMSibling(OMNode node);
-
-    public void setPreviousOMSibling(OMNode previousSibling);
-
-    public void setParent(OMContainer element);
-
-    public void setComplete(boolean state);
-
-    public void setType(int nodeType) throws OMException;
-
-    /**
-     * Serialize the node with caching
-     *
-     * @param omOutput
-     * @throws javax.xml.stream.XMLStreamException
-     * @see #serialize(org.apache.axis2.om.impl.OMOutputImpl)
-     */
-    public void serialize(org.apache.axis2.om.impl.OMOutputImpl omOutput)
-            throws XMLStreamException;
-
-    /**
-     * Serialize the node without caching
-     *
-     * @param omOutput
-     * @throws XMLStreamException
-     */
-    public void serializeAndConsume(OMOutputImpl omOutput) throws XMLStreamException;
-}
+/*
+ * Copyright 2004,2005 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.
+ */
+
+package org.apache.axis2.om.impl;
+
+import org.apache.axis2.om.OMContainer;
+import org.apache.axis2.om.OMException;
+import org.apache.axis2.om.OMNode;
+
+import javax.xml.stream.XMLStreamException;
+
+/**
+ * Interface OMNodeEx
+ *
+ * Internal Implementation detail. Adding special interface to stop folks from accidently using OMNode.
+ * Please use at your own risk. May corrupt the data integrity.
+ */
+public interface OMNodeEx extends OMNode {
+    public void setNextOMSibling(OMNode node);
+
+    public void setPreviousOMSibling(OMNode previousSibling);
+
+    public void setParent(OMContainer element);
+
+    public void setComplete(boolean state);
+
+    public void setType(int nodeType) throws OMException;
+
+    /**
+     * Serializes the node with caching.
+     *
+     * @param omOutput
+     * @throws javax.xml.stream.XMLStreamException
+     * @see #serialize(org.apache.axis2.om.impl.OMOutputImpl)
+     */
+    public void serialize(org.apache.axis2.om.impl.OMOutputImpl omOutput)
+            throws XMLStreamException;
+
+    /**
+     * Serializes the node without caching.
+     *
+     * @param omOutput
+     * @throws XMLStreamException
+     */
+    public void serializeAndConsume(OMOutputImpl omOutput) throws XMLStreamException;
+}

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMOutputImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMOutputImpl.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMOutputImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/OMOutputImpl.java Wed Jan  4 11:45:13 2006
@@ -33,8 +33,8 @@
 
 /**
  * For the moment this assumes that transport takes the decision of whether
- * to optimise or not by looking at whether the MTOM optimise is enabled &
- * also looking at the OM tree whether it has any optimisable content
+ * to optimize or not by looking at whether the MTOM optimize is enabled &
+ * also looking at the OM tree whether it has any optimizable content.
  */
 public class OMOutputImpl {
     private XMLStreamWriter xmlWriter;
@@ -48,7 +48,7 @@
     }
 
     /**
-     * This creates a new OMOutputImpl with specified encoding
+     * Creates a new OMOutputImpl with specified encoding.
      *
      * @param outStream
      * @param format
@@ -127,10 +127,10 @@
     }
 
     /**
-     * Returns the character set endocing scheme If the value of the
-     * charSetEncoding is not set then the default will be returned
+     * Returns the character set encoding scheme. If the value of the
+     * charSetEncoding is not set then the default will be returned.
      *
-     * @return encoding
+     * @return Returns encoding.
      */
     public String getCharSetEncoding() {
         return format.getCharSetEncoding();

Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPFactory.java?rev=365972&r1=365971&r2=365972&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPFactory.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPFactory.java Wed Jan  4 11:45:13 2006
@@ -31,25 +31,25 @@
 
     /**
      * @param builder
-     * @return
+     * @return Returns SOAPEnvelope.
      */
     public SOAPEnvelope createSOAPEnvelope(OMXMLParserWrapper builder);
 
     /**
-     * @return
+     * @return Returns SOAPEnvelope.
      */
     public SOAPEnvelope createSOAPEnvelope() throws SOAPProcessingException;
 
     /**
      * @param envelope
-     * @return
+     * @return Returns SOAPHeader.
      */
     public SOAPHeader createSOAPHeader(SOAPEnvelope envelope) throws SOAPProcessingException;
 
     /**
      * @param envelope
      * @param builder
-     * @return
+     * @return Returns SOAPHeader.
      */
     public SOAPHeader createSOAPHeader(SOAPEnvelope envelope,
                                        OMXMLParserWrapper builder);
@@ -57,7 +57,7 @@
     /**
      * @param localName
      * @param ns
-     * @return
+     * @return Returns SOAPHeaderBlock.
      */
     public SOAPHeaderBlock createSOAPHeaderBlock(String localName,
                                                  OMNamespace ns,
@@ -68,7 +68,7 @@
      * @param ns
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPHeaderBlock.
      */
     public SOAPHeaderBlock createSOAPHeaderBlock(String localName,
                                                  OMNamespace ns,
@@ -78,31 +78,30 @@
     /**
      * @param parent
      * @param e
-     * @return
+     * @return Returns SOAPFault.
      */
     public SOAPFault createSOAPFault(SOAPBody parent, Exception e) throws SOAPProcessingException;
 
     public SOAPFault createSOAPFault(SOAPBody parent) throws SOAPProcessingException;
 
     /**
-     * @param ns
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFault.
      */
     public SOAPFault createSOAPFault(SOAPBody parent,
                                      OMXMLParserWrapper builder);
 
     /**
      * @param envelope
-     * @return
+     * @return Returns SOAPBody.
      */
     public SOAPBody createSOAPBody(SOAPEnvelope envelope) throws SOAPProcessingException;
 
     /**
      * @param envelope
      * @param builder
-     * @return
+     * @return Returns SOAPBody.
      */
     public SOAPBody createSOAPBody(SOAPEnvelope envelope,
                                    OMXMLParserWrapper builder);
@@ -115,7 +114,7 @@
      * Code eii under SOAPFault (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultCode.
      */
     public SOAPFaultCode createSOAPFaultCode(SOAPFault parent) throws SOAPProcessingException;
 
@@ -124,7 +123,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultCode.
      */
     public SOAPFaultCode createSOAPFaultCode(SOAPFault parent,
                                              OMXMLParserWrapper builder);
@@ -137,7 +136,7 @@
      * Value eii under Code (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultValue.
      */
     public SOAPFaultValue createSOAPFaultValue(SOAPFaultCode parent) throws SOAPProcessingException;
 
@@ -146,7 +145,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultValue.
      */
     public SOAPFaultValue createSOAPFaultValue(SOAPFaultCode parent,
                                                OMXMLParserWrapper builder);
@@ -159,7 +158,7 @@
      * SubCode eii under Value (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultValue.
      */
 
     //added
@@ -177,7 +176,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultSubCode.
      */
     //changed
     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultCode parent,
@@ -187,7 +186,7 @@
      * SubCode eii under SubCode (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultSubCode.
      */
     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultSubCode parent) throws SOAPProcessingException;
 
@@ -196,7 +195,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultSubCode.
      */
     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultSubCode parent,
                                                    OMXMLParserWrapper builder);
@@ -210,7 +209,7 @@
      * Reason eii under SOAPFault (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultReason.
      */
     public SOAPFaultReason createSOAPFaultReason(SOAPFault parent) throws SOAPProcessingException;
 
@@ -219,7 +218,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultReason.
      */
     public SOAPFaultReason createSOAPFaultReason(SOAPFault parent,
                                                  OMXMLParserWrapper builder);
@@ -232,7 +231,7 @@
      * SubCode eii under SubCode (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultText.
      */
     public SOAPFaultText createSOAPFaultText(SOAPFaultReason parent) throws SOAPProcessingException;
 
@@ -241,7 +240,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultText.
      */
     public SOAPFaultText createSOAPFaultText(SOAPFaultReason parent,
                                              OMXMLParserWrapper builder);
@@ -255,7 +254,7 @@
      * Node eii under SOAPFault (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultNode.
      */
     public SOAPFaultNode createSOAPFaultNode(SOAPFault parent) throws SOAPProcessingException;
 
@@ -264,7 +263,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultNode.
      */
     public SOAPFaultNode createSOAPFaultNode(SOAPFault parent,
                                              OMXMLParserWrapper builder);
@@ -277,7 +276,7 @@
      * Role eii under SOAPFault (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultRole.
      */
     public SOAPFaultRole createSOAPFaultRole(SOAPFault parent) throws SOAPProcessingException;
 
@@ -286,7 +285,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultRole.
      */
     public SOAPFaultRole createSOAPFaultRole(SOAPFault parent,
                                              OMXMLParserWrapper builder);
@@ -299,7 +298,7 @@
      * Detail eii under SOAPFault (parent)
      *
      * @param parent
-     * @return
+     * @return Returns SOAPFaultDetail.
      */
     public SOAPFaultDetail createSOAPFaultDetail(SOAPFault parent) throws SOAPProcessingException;
 
@@ -308,7 +307,7 @@
      *
      * @param parent
      * @param builder
-     * @return
+     * @return Returns SOAPFaultDetail.
      */
     public SOAPFaultDetail createSOAPFaultDetail(SOAPFault parent,
                                                  OMXMLParserWrapper builder);
@@ -317,7 +316,7 @@
     /**
      * Method getDefaultEnvelope
      *
-     * @return
+     * @return Returns SOAPEnvelope.
      */
     public SOAPEnvelope getDefaultEnvelope() throws SOAPProcessingException;
 



Mime
View raw message