You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by di...@apache.org on 2006/01/05 20:21:21 UTC
svn commit: r366248 [1/2] - in /webservices/axis2/trunk/java/modules:
doom/src/org/apache/axis2/om/impl/dom/factory/
doom/src/org/apache/axis2/om/impl/dom/jaxp/
security/src/org/apache/axis2/security/handler/config/
wsdl/src/org/apache/axis2/wsdl/write...
Author: dims
Date: Thu Jan 5 11:21:04 2006
New Revision: 366248
URL: http://svn.apache.org/viewcvs?rev=366248&view=rev
Log:
javadoc fixes.
Modified:
webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/factory/OMDOMFactory.java
webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/jaxp/DocumentBuilderImpl.java
webservices/axis2/trunk/java/modules/security/src/org/apache/axis2/security/handler/config/OutflowConfiguration.java
webservices/axis2/trunk/java/modules/wsdl/src/org/apache/axis2/wsdl/writer/WOMtoWSDL11Writer.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMAttributeImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMCommentImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocTypeImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMElementImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNamespaceImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNavigator.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNodeImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMProcessingInstructionImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMSerializerUtil.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMStAXWrapper.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMTextImpl.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/builder/StAXBuilder.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/builder/StAXOMBuilder.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/factory/OMLinkedListImplFactory.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/factory/OMXMLBuilderFactory.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/mtom/MTOMStAXSOAPModelBuilder.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/serialize/StreamWriterToContentHandlerConverter.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/serialize/StreamingOMSerializer.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/traverse/OMChildElementIterator.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/traverse/OMChildrenIterator.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/traverse/OMChildrenQNameIterator.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/traverse/OMChildrenWithSpecificAttributeIterator.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/util/ElementHelper.java
webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/xpath/DocumentNavigator.java
Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/factory/OMDOMFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/factory/OMDOMFactory.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/factory/OMDOMFactory.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/factory/OMDOMFactory.java Thu Jan 5 11:21:04 2006
@@ -59,8 +59,8 @@
}
/**
- * Configure this factory to use the given document
- * Use with care :-)
+ * Configure this factory to use the given document.
+ * Use with care.
* @param document
*/
public void setDocument(DocumentImpl document) {
@@ -94,7 +94,7 @@
}
/**
- * Creating an OMElement with the builder
+ * Creates an OMElement with the builder.
*/
public OMElement createOMElement(String localName, OMNamespace ns, OMContainer parent, OMXMLParserWrapper builder) {
switch(((ParentNode)parent).getNodeType()) {
@@ -123,7 +123,7 @@
}
/**
- * Create an OMElement
+ * Creates an OMElement.
* @see org.apache.axis2.om.OMFactory#createOMElement(java.lang.String, java.lang.String, java.lang.String)
*/
public OMElement createOMElement(String localName, String namespaceURI, String namespacePrefix) {
@@ -132,7 +132,7 @@
}
/**
- * Create a new OMDOM Element node and add it to the given parent
+ * Creates a new OMDOM Element node and adds it to the given parent.
* @see #createOMElement(String, OMNamespace, OMContainer)
* @see org.apache.axis2.om.OMFactory#createOMElement(javax.xml.namespace.QName, org.apache.axis2.om.OMContainer)
*/
@@ -147,7 +147,7 @@
}
/**
- * Create a new OMNamespace
+ * Creates a new OMNamespace.
* @see org.apache.axis2.om.OMFactory#createOMNamespace(java.lang.String, java.lang.String)
*/
public OMNamespace createOMNamespace(String uri, String prefix) {
@@ -155,8 +155,8 @@
}
/**
- * Create a new OMDOM Text node with the given value and append it to the
- * given parent element
+ * Creates a new OMDOM Text node with the given value and appends it to the
+ * given parent element.
* @see org.apache.axis2.om.OMFactory#createText(org.apache.axis2.om.OMElement, java.lang.String)
*/
public OMText createText(OMElement parent, String text) {
@@ -173,7 +173,7 @@
}
/**
- * Create a OMDOM Text node carrying the given value
+ * Creates a OMDOM Text node carrying the given value.
*
* @see org.apache.axis2.om.OMFactory#createText(java.lang.String)
*/
@@ -182,7 +182,7 @@
}
/**
- * Create a Character node of the given type
+ * Creates a Character node of the given type.
* @see org.apache.axis2.om.OMFactory#createText(java.lang.String, int)
*/
public OMText createText(String text, int type) {
@@ -195,8 +195,8 @@
}
/**
- * Create a new OMDOM Text node with that has the value of the given text
- * value along with the MTOM optimization parameters and return it
+ * Creates a new OMDOM Text node with the value of the given text
+ * value along with the MTOM optimization parameters and returns it.
* @see org.apache.axis2.om.OMFactory#createText(java.lang.String, java.lang.String, boolean)
*/
public OMText createText(String text, String mimeType, boolean optimize) {
@@ -204,8 +204,8 @@
}
/**
- * Create a new OMDOM Text node with the given datahandler and the give
- * MTOM optimization configuration and return it
+ * Creates a new OMDOM Text node with the given datahandler and the given
+ * MTOM optimization configuration and returns it.
* @see org.apache.axis2.om.OMFactory#createText(java.lang.Object, boolean)
*/
public OMText createText(Object dataHandler, boolean optimize) {
@@ -213,7 +213,7 @@
}
/**
- * Create an OMDOM Text node, add it to the give parent element and return it
+ * Creates an OMDOM Text node, adds it to the give parent element and returns it.
* @see org.apache.axis2.om.OMFactory#createText(org.apache.axis2.om.OMElement, java.lang.String, java.lang.String, boolean)
*/
public OMText createText(OMElement parent, String s, String mimeType, boolean optimize) {
Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/jaxp/DocumentBuilderImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/jaxp/DocumentBuilderImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/jaxp/DocumentBuilderImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/jaxp/DocumentBuilderImpl.java Thu Jan 5 11:21:04 2006
@@ -43,9 +43,9 @@
}
/**
- * Returns whether the parser is configured to understand namespaces or not
+ * Returns whether the parser is configured to understand namespaces or not.
* The StAX parser used by this DOM impl is namespace aware
- * therefore this will always return true
+ * therefore this will always return true.
* @see javax.xml.parsers.DocumentBuilder#isNamespaceAware()
*/
public boolean isNamespaceAware() {
@@ -54,7 +54,7 @@
/**
* The StAX builder used is the org.apache.axis2.om.impl.llom.StAXOMBuilder
- * is a validating builder
+ * is a validating builder.
* @see javax.xml.parsers.DocumentBuilder#isValidating()
*/
public boolean isValidating() {
@@ -66,7 +66,7 @@
}
/**
- * Returns a new document impl
+ * Returns a new document impl.
* @see javax.xml.parsers.DocumentBuilder#newDocument()
*/
public Document newDocument() {
Modified: webservices/axis2/trunk/java/modules/security/src/org/apache/axis2/security/handler/config/OutflowConfiguration.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/security/src/org/apache/axis2/security/handler/config/OutflowConfiguration.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/security/src/org/apache/axis2/security/handler/config/OutflowConfiguration.java (original)
+++ webservices/axis2/trunk/java/modules/security/src/org/apache/axis2/security/handler/config/OutflowConfiguration.java Thu Jan 5 11:21:04 2006
@@ -30,7 +30,7 @@
/**
* This is the representation of the outflow configurations of the security
- * module
+ * module.
*/
public class OutflowConfiguration {
@@ -39,7 +39,7 @@
private int currentAction = 0;
/**
- * Create a default outflow configuration instance with 1 action
+ * Creates a default outflow configuration instance with an action.
*/
public OutflowConfiguration() {
this.actionList = new HashMap[1];
@@ -47,8 +47,8 @@
}
/**
- * Create a new outflow configuration instance with the given number of
- * actions
+ * Creates a new outflow configuration instance with the given number of
+ * actions.
*
* @param actionCount
*/
@@ -62,7 +62,7 @@
/**
* Returns the configuration as an Parameter
*
- * @return
+ * @return Returns Parameter.
*/
public Parameter getProperty() {
@@ -102,8 +102,8 @@
}
/**
- * Move to the next action If this is called when the current action is the
- * last action then the current action will not change
+ * Moves to the next action. If this is called when the current action is the
+ * last action then the current action will not change.
*
* @throws Exception
*/
@@ -114,8 +114,8 @@
}
/**
- * Move to previous action If this is called when the current action is the
- * first option then then the current action will not change
+ * Moves to previous action. If this is called when the current action is the
+ * first option then then the current action will not change.
*
* @throws Exception
*/
@@ -126,7 +126,7 @@
}
/**
- * Sets the action items
+ * Sets the action items.
*
* @param actionItems
*/
@@ -136,8 +136,8 @@
}
/**
- * Returns the action items
- * @return
+ * Returns the action items.
+ * @return Returns String.
*/
public String getActionItems() {
return (String) this.actionList[this.currentAction]
@@ -145,7 +145,7 @@
}
/**
- * Sets the user of the current action
+ * Sets the user of the current action.
*
* @param user
*/
@@ -154,8 +154,8 @@
}
/**
- * Returns the user of the current action
- * @return
+ * Returns the user of the current action.
+ * @return Returns String.
*/
public String getUser() {
return (String) this.actionList[this.currentAction]
@@ -163,9 +163,9 @@
}
/**
- * Sets the name of the password callback class of the current action
+ * Sets the name of the password callback class of the current action.
*
- * @param pwCallbackClass
+ * @param passwordCallbackClass
*/
public void setPasswordCallbackClass(String passwordCallbackClass) {
this.actionList[this.currentAction].put(
@@ -173,8 +173,8 @@
}
/**
- * Returns the name of the password callback class of the current action
- * @return
+ * Returns the name of the password callback class of the current action.
+ * @return Returns String.
*/
public String getPasswordCallbackClass() {
return (String) this.actionList[this.currentAction]
@@ -182,7 +182,7 @@
}
/**
- * Sets the signature property file of the current action
+ * Sets the signature property file of the current action.
*
* @param signaturePropFile
*/
@@ -192,8 +192,8 @@
}
/**
- * Returns the signature property file of the current action
- * @return
+ * Returns the signature property file of the current action.
+ * @return Returns String.
*/
public String getSignaturePropFile() {
return (String) this.actionList[this.currentAction]
@@ -201,7 +201,7 @@
}
/**
- * Sets the signatue key identifier of the current action
+ * Sets the signatue key identifier of the current action.
*
* @param signatureKeyIdentifier
*/
@@ -211,8 +211,8 @@
}
/**
- * Returns the signatue key identifier of the current action
- * @return
+ * Returns the signatue key identifier of the current action.
+ * @return Returns String.
*/
public String getSignatureKeyIdentifier() {
return (String) this.actionList[this.currentAction]
@@ -220,7 +220,7 @@
}
/**
- * sets the encrypted key identifier of the current action
+ * Sets the encrypted key identifier of the current action.
*
* @param encryptionKeyIdentifier
*/
@@ -230,8 +230,8 @@
}
/**
- * Returns the encrypted key identifier of the current action
- * @return
+ * Returns the encrypted key identifier of the current action.
+ * @return Returns String.
*/
public String getEncryptionKeyIdentifier() {
return (String) this.actionList[this.currentAction]
@@ -239,7 +239,7 @@
}
/**
- * Sets the encryption user of the current action
+ * Sets the encryption user of the current action.
*
* @param encryptionUser
*/
@@ -249,8 +249,8 @@
}
/**
- * Returns the encryption user of the current action
- * @return
+ * Returns the encryption user of the current action.
+ * @return Returns String.
*/
public String getEncryptionUser() {
return (String) this.actionList[this.currentAction]
@@ -258,7 +258,7 @@
}
/**
- * Sets the signature parts of the current action
+ * Sets the signature parts of the current action.
*
* @param signatureParts
*/
@@ -268,8 +268,8 @@
}
/**
- * Returns the signature parts of the current action
- * @return
+ * Returns the signature parts of the current action.
+ * @return Returns String.
*/
public String getSignatureParts() {
return (String) this.actionList[this.currentAction]
@@ -277,9 +277,9 @@
}
/**
- * Sets the encryption parts of the current action
+ * Sets the encryption parts of the current action.
*
- * @param signatureParts
+ * @param encryptionParts
*/
public void setEncryptionParts(String encryptionParts) {
this.actionList[this.currentAction].put(
@@ -287,8 +287,8 @@
}
/**
- * Returns the encryption parts of the current action
- * @return
+ * Returns the encryption parts of the current action.
+ * @return Returns String.
*/
public String getEncryptionParts() {
return (String) this.actionList[this.currentAction]
@@ -306,8 +306,8 @@
}
/**
- * Returns the password type of the current action
- * @return
+ * Returns the password type of the current action.
+ * @return Returns String.
*/
public String getPasswordType() {
return (String) this.actionList[this.currentAction]
@@ -325,8 +325,8 @@
}
/**
- * Returns the encryption symmetric algorithm of the current action
- * @return
+ * Returns the encryption symmetric algorithm of the current action.
+ * @return Returns String.
*/
public String getEncryptionSymAlgorithm() {
return (String) this.actionList[this.currentAction]
@@ -346,8 +346,8 @@
}
/**
- * Returns the encryption key transport algorithm of the current action
- * @return
+ * Returns the encryption key transport algorithm of the current action.
+ * @return Returns String.
*/
public String getEncryptionKeyTransportAlgorithm() {
return (String) this.actionList[this.currentAction]
@@ -366,9 +366,9 @@
}
/**
- * returns the embedded key callback class of the current action
+ * Returns the embedded key callback class of the current action.
*
- * @return
+ * @return Returns String.
*/
public String getEmbeddedKeyCallbackClass() {
return (String) this.actionList[this.currentAction]
@@ -377,7 +377,7 @@
/**
* Sets the XPath expression to selecte the elements with content of the
- * current action to be MTOM optimized
+ * current action to be MTOM optimized.
*
* @param optimizePartsXPathExpr
*/
@@ -388,9 +388,9 @@
/**
* Returns the Path expression to selecte the elements with content of the
- * current action to be MTOM optimized
+ * current action to be MTOM optimized.
*
- * @return
+ * @return Returns String.
*/
public String getOptimizeParts() {
return (String) this.actionList[this.currentAction]
@@ -398,7 +398,7 @@
}
/**
- * Sets the SAML property file of the current action
+ * Sets the SAML property file of the current action.
* @param samlPropFile
*/
public void setSamlPropFile(String samlPropFile) {
@@ -407,8 +407,8 @@
}
/**
- * Returns the SAML property file of the current action
- * @return
+ * Returns the SAML property file of the current action.
+ * @return Returns String.
*/
public String getSamlPropFile() {
return (String) this.actionList[this.currentAction]
@@ -416,7 +416,7 @@
}
/**
- * Sets the encryption property file
+ * Sets the encryption property file.
* @param encPropFile
*/
public void setEncryptionPropFile(String encPropFile) {
@@ -425,8 +425,8 @@
}
/**
- * Returns the encryption property file
- * @return
+ * Returns the encryption property file.
+ * @return Returns String.
*/
public String getEncryptionPropFile() {
return (String) this.actionList[this.currentAction]
@@ -434,7 +434,7 @@
}
/**
- * Option to add additional elements in the username token element
+ * Option to add additional elements in the username token element.
* Example: Nonce and Create elements
* @param addUTElements
*/
@@ -444,9 +444,7 @@
}
/**
- * Returns the additional elements to be
- * added to the username token element
- * @param addUTElements
+ * Returns the additional elements to be added to the username token element.
*/
public String getAddUTElements() {
return (String) this.actionList[this.currentAction]
@@ -454,7 +452,7 @@
}
/**
- * Sets the text of the key name that needs to be sent
+ * Sets the text of the key name that needs to be sent.
* @param embeddedKeyName
*/
public void setEmbeddedKeyName(String embeddedKeyName) {
@@ -463,8 +461,8 @@
}
/**
- * Returns the text of the key name that needs to be sent
- * @return
+ * Returns the text of the key name that needs to be sent.
+ * @return Returns String.
*/
public String getEmbeddedKeyName() {
return (String) this.actionList[this.currentAction]
@@ -472,8 +470,8 @@
}
/**
- * Sets whether signature confirmation should be enabled or not
- * @param embeddedKeyName
+ * Sets whether signature confirmation should be enabled or not.
+ * @param value
*/
public void setEnableSignatureConfirmation(boolean value) {
this.actionList[this.currentAction].put(
@@ -482,7 +480,7 @@
/**
* Returns whether signature confirmation should be enabled or not
- * @return
+ * @return Returns String.
*/
public String getEnableSignatureConfirmation() {
return (String) this.actionList[this.currentAction]
@@ -491,7 +489,7 @@
/**
* Sets whether signature confirmation should be enabled or not
- * @param embeddedKeyName
+ * @param value
*/
public void setPreserveOriginalEnvelope(boolean value) {
this.actionList[this.currentAction].put(
@@ -499,8 +497,8 @@
}
/**
- * Returns whether signature confirmation should be enabled or not
- * @return
+ * Returns whether signature confirmation should be enabled or not.
+ * @return Returns String.
*/
public String getPreserveOriginalEnvelope() {
return (String) this.actionList[this.currentAction]
Modified: webservices/axis2/trunk/java/modules/wsdl/src/org/apache/axis2/wsdl/writer/WOMtoWSDL11Writer.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/wsdl/src/org/apache/axis2/wsdl/writer/WOMtoWSDL11Writer.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/wsdl/src/org/apache/axis2/wsdl/writer/WOMtoWSDL11Writer.java (original)
+++ webservices/axis2/trunk/java/modules/wsdl/src/org/apache/axis2/wsdl/writer/WOMtoWSDL11Writer.java Thu Jan 5 11:21:04 2006
@@ -619,10 +619,7 @@
if (extElement instanceof Schema) {
Element element = ((Schema) extElement).getElement();
-// if (element.getNodeValue() != null) {
writeSchemas(element);
-// rawWriter.write(element.toString()); //quick hack for crimson
-// }
} else if (extElement instanceof SOAPAddress) {
writeSOAPAddressExtensibilityElement((SOAPAddress) extElement);
} else if (extElement instanceof SOAPBinding) {
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMAttributeImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMAttributeImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMAttributeImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMAttributeImpl.java Thu Jan 5 11:21:04 2006
@@ -41,7 +41,7 @@
private OMNamespace namespace;
/**
- * Constructor OMAttributeImpl
+ * Constructor OMAttributeImpl.
*
* @param localName
* @param ns
@@ -55,7 +55,7 @@
/**
*
- * @return qname
+ * @return Returns QName.
*/
public QName getQName() {
if(namespace != null){
@@ -68,16 +68,16 @@
// -------- Getters and Setters
/**
- * Method getLocalName
+ * Method getLocalName.
*
- * @return local name
+ * @return Returns local name.
*/
public String getLocalName() {
return localName;
}
/**
- * Method setLocalName
+ * Method setLocalName.
*
* @param localName
*/
@@ -86,16 +86,16 @@
}
/**
- * Method getValue
+ * Method getAttributeValue.
*
- * @return value
+ * @return Returns value.
*/
public String getAttributeValue() {
return value;
}
/**
- * Method setValue
+ * Method setAttributeValue.
*
* @param value
*/
@@ -104,7 +104,7 @@
}
/**
- * Method setOMNamespace
+ * Method setOMNamespace.
*
* @param omNamespace
*/
@@ -113,9 +113,9 @@
}
/**
- * Method getNamespace
+ * Method getNamespace.
*
- * @return namespace
+ * @return Returns namespace.
*/
public OMNamespace getNamespace() {
return namespace;
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMCommentImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMCommentImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMCommentImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMCommentImpl.java Thu Jan 5 11:21:04 2006
@@ -30,7 +30,7 @@
protected String value;
/**
- * Constructor OMCommentImpl
+ * Constructor OMCommentImpl.
*
* @param parentNode
* @param contentText
@@ -43,7 +43,7 @@
}
/**
- * Constructor OMCommentImpl
+ * Constructor OMCommentImpl.
*
* @param parentNode
*/
@@ -52,7 +52,7 @@
}
/**
- * Serialize the node with caching
+ * Serializes the node with caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -64,7 +64,7 @@
}
/**
- * Serialize the node without caching
+ * Serializes the node without caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -75,16 +75,16 @@
}
/**
- * get the value of this comment
+ * Gets the value of this comment.
*
- * @return string
+ * @return Returns String.
*/
public String getValue() {
return value;
}
/**
- * set the value of this comment
+ * Sets the value of this comment.
*
* @param text
*/
@@ -93,7 +93,7 @@
}
/**
- * discard this node
+ * Discards this node.
*
* @throws OMException
*/
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocTypeImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocTypeImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocTypeImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocTypeImpl.java Thu Jan 5 11:21:04 2006
@@ -30,7 +30,7 @@
protected String value;
/**
- * Constructor OMDocTypeImpl
+ * Constructor OMDocTypeImpl.
*
* @param parentNode
* @param contentText
@@ -42,7 +42,7 @@
}
/**
- * Constructor OMDocTypeImpl
+ * Constructor OMDocTypeImpl.
*
* @param parentNode
*/
@@ -51,7 +51,7 @@
}
/**
- * Serialize the node with caching
+ * Serializes the node with caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -63,7 +63,7 @@
}
/**
- * Serialize the node without caching
+ * Serializes the node without caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -74,16 +74,16 @@
}
/**
- * get the value of this DocType
+ * Gets the value of this DocType.
*
- * @return string
+ * @return Returns String.
*/
public String getValue() {
return value;
}
/**
- * set the value of this DocType
+ * Sets the value of this DocType.
*
* @param text
*/
@@ -92,7 +92,7 @@
}
/**
- * discard this node
+ * Discards this node.
*
* @throws OMException
*/
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMDocumentImpl.java Thu Jan 5 11:21:04 2006
@@ -64,7 +64,7 @@
/**
* Field charSetEncoding
- * Dafult : UTF-8
+ * Default : UTF-8
*/
protected String charSetEncoding = "UTF-8";
@@ -100,9 +100,9 @@
}
/**
- * Method getDocumentElement
+ * Method getDocumentElement.
*
- * @return om element
+ * @return Returns OMElement.
*/
public OMElement getOMDocumentElement() {
while (documentElement == null) {
@@ -112,7 +112,7 @@
}
/**
- * Method setDocumentElement
+ * Method setDocumentElement.
*
* @param documentElement
*/
@@ -121,18 +121,18 @@
}
/**
- * 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
- * item has been parsed completely or not.
+ * Indicates whether parser has parsed this information item completely or not.
+ * If some information is 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() {
return done;
}
/**
- * Method setComplete
+ * Method setComplete.
*
* @param state
*/
@@ -141,7 +141,7 @@
}
/**
- * This will force the parser to proceed, if parser has not yet finished with the XML input
+ * Forces the parser to proceed, if parser has not yet finished with the XML input.
*/
public void buildNext() {
if (!parserWrapper.isCompleted())
@@ -149,8 +149,8 @@
}
/**
- * This will add child to the element. One can decide whether he append the child or he adds to the
- * front of the children list
+ * Adds child to the element. One can decide whether to append the child or to add to the
+ * front of the children list.
*
* @param child
*/
@@ -168,7 +168,7 @@
}
/**
- * Method addChild
+ * Method addChild.
*
* @param child
*/
@@ -187,22 +187,22 @@
}
/**
- * This returns a collection of this element.
+ * Returns a collection of this element.
* Children can be of types OMElement, OMText.
*
- * @return iterator
+ * @return Returns iterator.
*/
public Iterator getChildren() {
return new OMChildrenIterator(getFirstOMChild());
}
/**
- * This will search for children with a given QName and will return an iterator to traverse through
+ * Searches for children with a given QName and returns an iterator to traverse through
* the OMNodes.
- * This QName can contain any combination of prefix, localname and URI
+ * The QName can contain any combination of prefix, localname and URI.
*
* @param elementQName
- * @return
+ * @return Returns Iterator.
* @throws org.apache.axis2.om.OMException
*/
public Iterator getChildrenWithName(QName elementQName) {
@@ -211,9 +211,9 @@
}
/**
- * Method getFirstOMChild
+ * Method getFirstOMChild.
*
- * @return first om child
+ * @return Returns first om child.
*/
public OMNode getFirstOMChild() {
while ((firstChild == null) && !done) {
@@ -223,10 +223,10 @@
}
/**
- * Method getFirstChildWithName
+ * Method getFirstChildWithName.
*
* @param elementQName
- * @return
+ * @return Returns OMElement.
* @throws OMException
*/
public OMElement getFirstChildWithName(QName elementQName) throws OMException {
@@ -244,7 +244,7 @@
}
/**
- * Method setFirstChild
+ * Method setFirstChild.
*
* @param firstChild
*/
@@ -254,16 +254,16 @@
/**
- * Returns the character set encoding scheme to be used
+ * Returns the character set encoding scheme to be used.
*
- * @return charset
+ * @return Returns charset.
*/
public String getCharsetEncoding() {
return charSetEncoding;
}
/**
- * Set the character set encoding scheme
+ * Sets the character set encoding scheme.
*
* @param charEncoding
*/
@@ -295,7 +295,7 @@
}
/**
- * Serialize the document with the XML declaration
+ * Serializes the document with the XML declaration.
*/
public void serializeAndConsume(OMOutputImpl omOutput)
throws XMLStreamException {
@@ -304,7 +304,7 @@
/**
- * Serialize the document with cache
+ * Serializes the document with cache.
*/
public void serialize(OMOutputImpl omOutput) throws XMLStreamException {
serialize(omOutput, true, !omOutput.isIgnoreXMLDeclaration());
@@ -312,7 +312,7 @@
}
/**
- * Serialize the document directly to the outputstream with Caching disabled
+ * Serializes the document directly to the output stream with caching disabled.
*
* @param output
* @throws XMLStreamException
@@ -324,7 +324,7 @@
}
/**
- * Serialize the document directly to the outputstream with Caching enabled
+ * Serializes the document directly to the output stream with caching enabled.
*
* @param output
* @throws XMLStreamException
@@ -336,7 +336,7 @@
}
/**
- * Serialize the document directly to the outputstream with Caching disabled
+ * Serializes the document directly to the output stream with caching disabled.
*
* @param output
* @param format
@@ -349,7 +349,7 @@
}
/**
- * Serialize the document directly to the outputstream with Caching enabled
+ * Serializes the document directly to the output stream with caching enabled.
*
* @param output
* @param format
@@ -362,7 +362,7 @@
}
/**
- * Serialize the document with cache
+ * Serializes the document with cache.
*/
public void serialize(OMOutputImpl omOutput, boolean includeXMLDeclaration) throws XMLStreamException {
serialize(omOutput, true, includeXMLDeclaration);
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMElementImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMElementImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMElementImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMElementImpl.java Thu Jan 5 11:21:04 2006
@@ -80,7 +80,7 @@
private OMNode lastChild;
/**
- * Constructor OMElementImpl
+ * Constructor OMElementImpl.
*/
public OMElementImpl(String localName, OMNamespace ns, OMContainer parent,
OMXMLParserWrapper builder) {
@@ -95,15 +95,15 @@
/**
- * Constructor OMElementImpl
+ * Constructor OMElementImpl.
*/
public OMElementImpl(String localName, OMNamespace ns) {
this(localName, ns, null);
}
/**
- * This is the basic constructor for OMElement. All the other constructors within this class
- * will depend on this.
+ * This is the basic constructor for OMElement. All the other constructors
+ * depends on this.
*
* @param localName - this MUST always be not null
* @param ns - can be null
@@ -122,7 +122,7 @@
}
/**
- * Here it is assumed that this QName passed, at least contains the localName for this element
+ * It is assumed that the QName passed contains, at least, the localName for this element.
*
* @param qname - this should be valid qname according to javax.xml.namespace.QName
* @throws OMException
@@ -133,7 +133,7 @@
}
/**
- * Method handleNamespace
+ * Method handleNamespace.
*/
private OMNamespace handleNamespace(QName qname) {
OMNamespace ns = null;
@@ -168,9 +168,9 @@
}
/**
- * Method handleNamespace
+ * Method handleNamespace.
*
- * @return namespace
+ * @return Returns namespace.
*/
private OMNamespace handleNamespace(OMNamespace ns) {
OMNamespace namespace = findNamespace(ns.getName(),
@@ -182,19 +182,17 @@
}
/**
- * This will add child to the element. One can decide whether he append the child or he adds to the
- * front of the children list
+ * Adds child to the element. One can decide whether to append the child or to add to the
+ * front of the children list.
*/
public void addChild(OMNode child) {
addChild((OMNodeImpl) child);
}
/**
- * This will search for children with a given QName and will return an iterator to traverse through
+ * Searches for children with a given QName and returns an iterator to traverse through
* the OMNodes.
- * This QName can contain any combination of prefix, localname and URI
- *
- * @throws OMException
+ * This QName can contain any combination of prefix, localname and URI.
*
* @throws OMException
*/
@@ -204,7 +202,7 @@
}
/**
- * Method getFirstChildWithName
+ * Method getFirstChildWithName.
*
* @throws OMException
*/
@@ -223,7 +221,7 @@
}
/**
- * Method addChild
+ * Method addChild.
*/
private void addChild(OMNodeImpl child) {
//the order of these statements is VERY important
@@ -247,9 +245,8 @@
}
/**
- * This will give the next sibling. This can be an OMAttribute for OMAttribute or OMText or OMELement for others.
- *
- * @throws OMException
+ * Gets the next sibling. This can be an OMAttribute or OMText or
+ * OMELement for others.
*
* @throws OMException
*/
@@ -264,10 +261,9 @@
}
/**
- * This returns a collection of this element.
- * Children can be of types OMElement, OMText.
+ * Returns a collection of this element. Children can be of types OMElement, OMText.
*
- * @return children
+ * @return Returns children.
*/
public Iterator getChildren() {
return new OMChildrenIterator(getFirstOMChild());
@@ -276,16 +272,16 @@
/**
* Returns a filtered list of children - just the elements.
*
- * @return an iterator over the child elements
+ * @return Returns an iterator of the child elements.
*/
public Iterator getChildElements() {
return new OMChildElementIterator(getFirstElement());
}
/**
- * THis will create a namespace in the current element scope
+ * Creates a namespace in the current element scope.
*
- * @return namespace
+ * @return Returns namespace.
*/
public OMNamespace declareNamespace(String uri, String prefix) {
OMNamespaceImpl ns = new OMNamespaceImpl(uri, prefix);
@@ -293,7 +289,7 @@
}
/**
- * @return namespace
+ * @return Returns namespace.
*/
public OMNamespace declareNamespace(OMNamespace namespace) {
if (namespaces == null) {
@@ -304,9 +300,9 @@
}
/**
- * This will find a namespace with the given uri and prefix, in the scope of the docuemnt.
- * This will start to find from the current element and goes up in the hiararchy until this finds one.
- * If none is found, return null
+ * Finds a namespace with the given uri and prefix, in the scope of the document.
+ * Starts to find from the current element and goes up in the hiararchy until one is found.
+ * If none is found, returns null.
*/
public OMNamespace findNamespace(String uri, String prefix) {
@@ -339,9 +335,8 @@
}
/**
- * This will ckeck for the namespace <B>only</B> in the current Element.
- * <p/>
- * This can also be used to retrieve the prefix of a known namespace URI
+ * Checks for the namespace <B>only</B> in the current Element.
+ * This is also used to retrieve the prefix of a known namespace URI.
*/
private OMNamespace findDeclaredNamespace(String uri, String prefix) {
@@ -382,9 +377,9 @@
/**
- * Method getAllDeclaredNamespaces
+ * Method getAllDeclaredNamespaces.
*
- * @return iterator
+ * @return Returns Iterator.
*/
public Iterator getAllDeclaredNamespaces() {
if (namespaces == null) {
@@ -406,9 +401,9 @@
}
/**
- * This will return a List of OMAttributes
+ * Returns a List of OMAttributes.
*
- * @return iterator
+ * @return Returns iterator.
*/
public Iterator getAllAttributes() {
if (attributes == null) {
@@ -418,20 +413,20 @@
}
/**
- * 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 attributes == null ? null : (OMAttribute) attributes.get(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) {
OMAttribute attr = getAttribute(qname);
@@ -439,10 +434,10 @@
}
/**
- * This will insert attribute to this element. Implementor can decide as to insert this
- * in the front or at the end of set of attributes
+ * Inserts an attribute to this element. Implementor can decide as to insert this
+ * in the front or at the end of set of attributes.
*
- * @return attribute
+ * @return Returns attribute.
*/
public OMAttribute addAttribute(OMAttribute attr) {
if (attributes == null) {
@@ -458,7 +453,7 @@
}
/**
- * Method removeAttribute
+ * Method removeAttribute.
*/
public void removeAttribute(OMAttribute attr) {
if (attributes != null) {
@@ -467,9 +462,9 @@
}
/**
- * Method addAttribute
+ * Method addAttribute.
*
- * @return attribute
+ * @return Returns OMAttribute.
*/
public OMAttribute addAttribute(String attributeName, String value,
OMNamespace ns) {
@@ -489,32 +484,32 @@
}
/**
- * Method setBuilder
+ * Method setBuilder.
*/
public void setBuilder(OMXMLParserWrapper wrapper) {
this.builder = wrapper;
}
/**
- * Method getBuilder
+ * Method getBuilder.
*
- * @return builder
+ * @return Returns OMXMLParserWrapper.
*/
public OMXMLParserWrapper getBuilder() {
return builder;
}
/**
- * This will force the parser to proceed, if parser has not yet finished with the XML input
+ * Forces the parser to proceed, if parser has not yet finished with the XML input.
*/
public void buildNext() {
builder.next();
}
/**
- * Method getFirstOMChild
+ * Method getFirstOMChild.
*
- * @return child
+ * @return Returns child.
*/
public OMNode getFirstOMChild() {
while ((firstChild == null) && !done) {
@@ -524,7 +519,7 @@
}
/**
- * Method setFirstChild
+ * Method setFirstChild.
*/
public void setFirstChild(OMNode firstChild) {
if (firstChild != null) {
@@ -534,9 +529,7 @@
}
/**
- * This will remove this information item and its children, from the model completely
- *
- * @throws OMException
+ * Removes this information item and its children, from the model completely.
*
* @throws OMException
*/
@@ -550,23 +543,23 @@
}
/**
- * Method isComplete
+ * Method isComplete.
*
- * @return boolean
+ * @return Returns boolean.
*/
public boolean isComplete() {
return done;
}
/**
- * This is to get the type of node, as this is the super class of all the nodes
+ * Gets the type of node, as this is the super class of all the nodes.
*/
public int getType() {
return OMNode.ELEMENT_NODE;
}
/**
- * getXMLStreamReader
+ * Method getXMLStreamReader.
*
* @see OMElement#getXMLStreamReader()
*/
@@ -575,7 +568,7 @@
}
/**
- * getXMLStreamReaderWithoutCaching
+ * Method getXMLStreamReaderWithoutCaching.
*
* @see OMElement#getXMLStreamReaderWithoutCaching()
*/
@@ -584,9 +577,9 @@
}
/**
- * getXMLStreamReader
+ * Method getXMLStreamReader.
*
- * @return reader
+ * @return Returns reader.
*/
private XMLStreamReader getXMLStreamReader(boolean cache) {
if ((builder == null) && !cache) {
@@ -603,7 +596,7 @@
/**
* Sets the text of the given element.
* caution - This method will wipe out all the text elements (and hence any
- * moxed content) before setting the text
+ * mixed content) before setting the text.
*/
public void setText(String text) {
@@ -619,9 +612,9 @@
}
/**
- * select all the text children and concat them to a single string
+ * Selects all the text children and concatinates them to a single string.
*
- * @return text
+ * @return Returns String.
*/
public String getText() {
String childText = "";
@@ -643,9 +636,9 @@
}
/**
- * Returns the concatanation of TRIMMED values of all
- * OMText child nodes of this element
- * This is incuded purely to improve usability
+ * Returns the concatination string of TRIMMED values of all
+ * OMText child nodes of this element.
+ * This is included purely to improve usability.
*/
public String getTrimmedText() {
String childText = "";
@@ -667,7 +660,7 @@
}
/**
- * Method serializeAndConsume
+ * Method serialize.
*
* @throws XMLStreamException
*/
@@ -719,10 +712,10 @@
////////////////////////////////////////////////////////////////////////////////////////////////
/**
- * This was requested during the second Axis2 summit. When one call this method, this will
- * serializeAndConsume without building the object structure in the memory. Misuse of this method will
- * cause loss of data.So its advised to use populateYourSelf() method, before this,
- * if you want to preserve data in the stream.
+ * This method serializes and consumes without building the object structure in memory.
+ * Misuse of this method will cause loss of data. So it is advised to use
+ * populateYourSelf() method, before calling this method, if one wants to
+ * preserve data in the stream. This was requested during the second Axis2 summit.
*
* @throws XMLStreamException
*/
@@ -731,9 +724,9 @@
}
/**
- * Get first element
+ * Gets first element.
*
- * @return element
+ * @return Returns element.
*/
public OMElement getFirstElement() {
OMNode node = getFirstOMChild();
@@ -748,23 +741,23 @@
}
/**
- * Method getLocalName
+ * Method getLocalName.
*
- * @return local name
+ * @return Returns local name.
*/
public String getLocalName() {
return localName;
}
/**
- * Method setLocalName
+ * Method setLocalName.
*/
public void setLocalName(String localName) {
this.localName = localName;
}
/**
- * Method getNamespace
+ * Method getNamespace.
*
* @throws OMException
*/
@@ -773,7 +766,7 @@
}
/**
- * Method setNamespace
+ * Method setNamespace.
*/
public void setNamespace(OMNamespace namespace) {
OMNamespace nsObject = null;
@@ -784,9 +777,9 @@
}
/**
- * Method getQName
+ * Method getQName.
*
- * @return qname
+ * @return Returns QName.
*/
public QName getQName() {
QName qName;
@@ -819,7 +812,7 @@
}
/**
- * Discard implementation
+ * Method discard.
*
* @throws OMException
*/
@@ -832,11 +825,11 @@
}
/**
- * Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context
- * unprefixed qnames resolve to the local namespace
+ * Converts 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.
*/
public QName resolveQName(String qname) {
ElementHelper helper = new ElementHelper(this);
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNamespaceImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNamespaceImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNamespaceImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNamespaceImpl.java Thu Jan 5 11:21:04 2006
@@ -42,11 +42,11 @@
}
/**
- * Method equals
+ * Method equals.
*
* @param uri
* @param prefix
- * @return
+ * @return Returns boolean.
*/
public boolean equals(String uri, String prefix) {
return (((prefix == null) && (this.prefix == null)) ||
@@ -55,18 +55,18 @@
}
/**
- * Method getPrefix
+ * Method getPrefix.
*
- * @return
+ * @return Returns String.
*/
public String getPrefix() {
return prefix;
}
/**
- * Method getName
+ * Method getName.
*
- * @return
+ * @return Returns String.
*/
public String getName() {
return uri;
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNavigator.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNavigator.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNavigator.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNavigator.java Thu Jan 5 11:21:04 2006
@@ -22,7 +22,7 @@
/**
* Refer to the testClass to find out how to use
- * features like isNavigable, isComplete and step
+ * features like isNavigable, isComplete and step.
*/
public class OMNavigator {
/**
@@ -66,13 +66,13 @@
private boolean start = true;
/**
- * Constructor OMNavigator
+ * Constructor OMNavigator.
*/
public OMNavigator() {
}
/**
- * Constructor OMNavigator
+ * Constructor OMNavigator.
*
* @param node
*/
@@ -81,7 +81,7 @@
}
/**
- * Method init
+ * Method init.
*
* @param node
*/
@@ -92,11 +92,11 @@
}
/**
- * get the next node
+ * Gets the next node.
*
- * @return OMnode in the sequence of preorder traversal. Note however that an element node is
- * treated slightly differently. Once the element is passed it returns the same element in the
- * next encounter as well
+ * @return Returns OMnode in the sequence of preorder traversal. Note however
+ * that an element node is treated slightly differently. Once the
+ * element is passed it returns the same element in the next encounter as well.
*/
public OMNode next() {
if (next == null) {
@@ -119,7 +119,7 @@
}
/**
- * Private method to encapsulate the searching logic
+ * Private method to encapsulate the searching logic.
*/
private void updateNextNode() {
if ((next instanceof OMElement) && !visited) {
@@ -147,9 +147,9 @@
}
/**
- * Method visited
+ * Method visited.
*
- * @return
+ * @return Returns boolean.
*/
public boolean visited() {
return visited;
@@ -157,10 +157,10 @@
/**
* This is a very special method. This allows the navigator to step
- * once it has reached the existing om. At this point the isNavigable
+ * once it has reached the existing OM. At this point the isNavigable
* method will return false but the isComplete method may return false
- * which means that the navigating the given element is not complete but
- * the navigator cannot proceed
+ * which means that the navigating the given element is not complete and
+ * the navigator cannot proceed.
*/
public void step() {
if (!end) {
@@ -170,9 +170,9 @@
}
/**
- * the navigable status
+ * Returns the navigable status.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isNavigable() {
if (end) {
@@ -183,9 +183,9 @@
}
/**
- * The completed status
+ * Returns the completed status.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isCompleted() {
return end;
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNodeImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNodeImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNodeImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMNodeImpl.java Thu Jan 5 11:21:04 2006
@@ -71,7 +71,7 @@
}
/**
- * For a node to exist there must be a parent
+ * For a node to exist there must be a parent.
*
* @param parent
*/
@@ -83,10 +83,9 @@
}
/**
- * This method should return the immediate parent of the node.
- * Parent is always an Element
+ * Returns the immediate parent of the node. Parent is always an Element.
*
- * @return
+ * @return Returns OMContainer.
*
* @throws OMException
*/
@@ -95,7 +94,7 @@
}
/**
- * Method setParent
+ * Method setParent.
*
* @param element
*/
@@ -115,12 +114,11 @@
}
/**
- * This will give the next sibling. This can be an OMAttribute for OMAttribute or OMText or OMELement for others.
+ * Returns the next sibling. This can be an OMAttribute or
+ * OMText or OMElement for others.
*
- * @return
+ * @return Returns OMNode.
* @throws org.apache.axis2.om.OMException
- *
- * @throws OMException
*/
public OMNode getNextOMSibling() throws OMException {
if ((nextSibling == null) && (parent != null) && !parent.isComplete()) {
@@ -130,7 +128,7 @@
}
/**
- * Method setNextOMSibling
+ * Method setNextOMSibling.
*
* @param node
*/
@@ -140,18 +138,18 @@
/**
- * 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
- * item has been parsed completely or not.
+ * Indicates whether parser has parsed this information item completely or not.
+ * If some information is 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() {
return done;
}
/**
- * Method setComplete
+ * Method setComplete.
*
* @param state
*/
@@ -160,9 +158,7 @@
}
/**
- * This will remove this information item and its children, from the model completely
- *
- * @throws org.apache.axis2.om.OMException
+ * Removes this information item and its children, from the model completely.
*
* @throws OMException
*/
@@ -185,11 +181,9 @@
}
/**
- * This will insert a sibling just after the current information item.
+ * Inserts a sibling just after the current information item.
*
* @param sibling
- * @throws org.apache.axis2.om.OMException
- *
* @throws OMException
*/
public void insertSiblingAfter(OMNode sibling) throws OMException {
@@ -212,11 +206,9 @@
}
/**
- * This will insert a sibling just before the current information item
+ * Inserts a sibling just before the current information item.
*
* @param sibling
- * @throws org.apache.axis2.om.OMException
- *
* @throws OMException
*/
public void insertSiblingBefore(OMNode sibling) throws OMException {
@@ -240,7 +232,7 @@
}
/**
- * This is to get the type of node, as this is the super class of all the nodes
+ * Gets the type of node, as this is the super class of all the nodes.
*
* @return Returns the type of node as indicated by {@link #setType}
*
@@ -251,7 +243,7 @@
}
/**
- * Method setType
+ * Method setType.
*
* @param nodeType
* @throws OMException
@@ -261,7 +253,7 @@
}
/**
- * Method getPreviousOMSibling
+ * Gets the previous sibling.
*
* @return boolean
*/
@@ -270,7 +262,7 @@
}
/**
- * Method setPreviousOMSibling
+ * Method setPreviousOMSibling.
*
* @param previousSibling
*/
@@ -280,9 +272,9 @@
/**
- * This will completely parse this node and build the object structure in the memory.
- * However a programmatically created node will have done set to true by default and will cause
- * populateyourself not to work properly!
+ * Parses this node and builds the object structure in memory.
+ * However a node, created programmatically, will have done set to true by
+ * default and this will cause populateyourself not to work properly!
*
* @throws OMException
*/
@@ -293,7 +285,7 @@
}
/**
- * Serialize the node with caching
+ * Serializes the node with caching.
*
* @param xmlWriter
* @throws javax.xml.stream.XMLStreamException
@@ -307,7 +299,7 @@
}
/**
- * Serialize the node without caching
+ * Serializes the node without caching.
*
* @param xmlWriter
* @throws javax.xml.stream.XMLStreamException
@@ -321,7 +313,7 @@
}
/**
- * Serialize the node with caching
+ * Serializes the node with caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -332,7 +324,7 @@
}
/**
- * Serialize the node without caching
+ * Serializes the node without caching.
*
* @param omOutput
* @throws XMLStreamException
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMProcessingInstructionImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMProcessingInstructionImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMProcessingInstructionImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMProcessingInstructionImpl.java Thu Jan 5 11:21:04 2006
@@ -30,7 +30,7 @@
protected String value;
/**
- * Constructor OMProcessingInstructionImpl
+ * Constructor OMProcessingInstructionImpl.
*
* @param parentNode
* @param target
@@ -44,7 +44,7 @@
}
/**
- * Constructor OMProcessingInstructionImpl
+ * Constructor OMProcessingInstructionImpl.
*
* @param parentNode
*/
@@ -53,7 +53,7 @@
}
/**
- * Serialize the node with caching
+ * Serializes the node with caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -65,7 +65,7 @@
}
/**
- * Serialize the node without caching
+ * Serializes the node without caching.
*
* @param omOutput
* @throws XMLStreamException
@@ -76,7 +76,7 @@
}
/**
- * get the value of this PI
+ * Gets the value of this Processing Instruction.
*
* @return string
*/
@@ -85,7 +85,7 @@
}
/**
- * set the target of this PI
+ * Sets the target of this Processing Instruction.
*
* @param target
*/
@@ -94,16 +94,16 @@
}
/**
- * get the target of this PI
+ * Gets the target of this Processing Instruction.
*
- * @return string
+ * @return Returns String.
*/
public String getTarget() {
return target;
}
/**
- * set the value of this PI
+ * Sets the value of this Processing Instruction.
*
* @param text
*/
@@ -112,7 +112,7 @@
}
/**
- * discard this node
+ * Discards this node.
*
* @throws OMException
*/
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMSerializerUtil.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMSerializerUtil.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMSerializerUtil.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMSerializerUtil.java Thu Jan 5 11:21:04 2006
@@ -32,7 +32,7 @@
public class OMSerializerUtil {
/**
- * Method serializeEndpart
+ * Method serializeEndpart.
*
* @param omOutput
* @throws javax.xml.stream.XMLStreamException
@@ -44,7 +44,7 @@
}
/**
- * Method serializeAttribute
+ * Method serializeAttribute.
*
* @param attr
* @param omOutput
@@ -76,7 +76,7 @@
}
/**
- * Method serializeNamespace
+ * Method serializeNamespace.
*
* @param namespace
* @param omOutput
@@ -98,7 +98,7 @@
/**
- * Method serializeStartpart
+ * Method serializeStartpart.
*
* @param omOutput
* @throws XMLStreamException
@@ -167,7 +167,7 @@
/**
- * Method serializeNormal
+ * Method serializeNormal.
*
* @param omOutput
* @param cache
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMStAXWrapper.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMStAXWrapper.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMStAXWrapper.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMStAXWrapper.java Thu Jan 5 11:21:04 2006
@@ -65,10 +65,10 @@
*/
private boolean isFirst = true;
- // navigable means the output should be taken from the navigator
- // as soon as the navigator returns a null navigable will be reset
+ // Navigable means the output should be taken from the navigator.
+ // As soon as the navigator returns a null navigable will be reset
// to false and the subsequent events will be taken from the builder
- // or the parser directly
+ // or the parser directly.
/**
* Field NAVIGABLE
@@ -91,10 +91,10 @@
*/
private int currentEvent = START_DOCUMENT;
- // SwitchingAllowed is set to false by default
- // this means that unless the user explicitly states
+ // SwitchingAllowed is set to false by default.
+ // This means that unless the user explicitly states
// that he wants things not to be cached, everything will
- // be cached
+ // be cached.
/**
* Field switchingAllowed
@@ -137,7 +137,7 @@
private boolean needToThrowEndDocument = false;
/**
- * Method setAllowSwitching
+ * Method setAllowSwitching.
*
* @param b
*/
@@ -146,9 +146,9 @@
}
/**
- * Method isAllowSwitching
+ * Method isAllowSwitching.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isAllowSwitching() {
return switchingAllowed;
@@ -157,9 +157,9 @@
/**
* When constructing the OMStaxWrapper, the creator must produce the
* builder (an instance of the OMXMLparserWrapper of the input) and the
- * Element Node to start parsing. The wrapper wil parse(proceed) until
- * the end of the given element. hence care should be taken to pass the
- * root element if the entire document is needed
+ * Element Node to start parsing. The wrapper will parse(proceed) until
+ * the end of the given element. Hence care should be taken to pass the
+ * root element if the entire document is needed.
*
* @param builder
* @param startNode
@@ -169,7 +169,7 @@
}
/**
- * Constructor OMStAXWrapper
+ * Constructor OMStAXWrapper.
*
* @param builder
* @param startNode
@@ -195,7 +195,7 @@
}
/**
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getPrefix()
*/
public String getPrefix() {
@@ -215,7 +215,7 @@
}
/**
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getNamespaceURI()
*/
public String getNamespaceURI() {
@@ -236,7 +236,7 @@
}
/**
- * @return
+ * @return Returns boolean.
* @see javax.xml.stream.XMLStreamReader#hasName()
*/
public boolean hasName() {
@@ -249,7 +249,7 @@
}
/**
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getLocalName()
*/
public String getLocalName() {
@@ -267,7 +267,7 @@
}
/**
- * @return
+ * @return Returns QName.
* @see javax.xml.stream.XMLStreamReader#getName()
*/
public QName getName() {
@@ -284,7 +284,7 @@
}
/**
- * @return
+ * @return Returns boolean.
* @see javax.xml.stream.XMLStreamReader#hasText()
*/
public boolean hasText() {
@@ -294,7 +294,7 @@
}
/**
- * @return
+ * @return Returns int.
* @see javax.xml.stream.XMLStreamReader#getTextLength()
*/
public int getTextLength() {
@@ -309,7 +309,7 @@
}
/**
- * @return
+ * @return Returns int.
* @see javax.xml.stream.XMLStreamReader#getTextStart()
*/
public int getTextStart() {
@@ -327,7 +327,7 @@
* @param chars
* @param i1
* @param i2
- * @return
+ * @return Returns int.
* @throws XMLStreamException
* @see javax.xml.stream.XMLStreamReader#getTextCharacters(int, char[], int, int)
*/
@@ -351,7 +351,7 @@
}
/**
- * @return
+ * @return Returns char[].
* @see javax.xml.stream.XMLStreamReader#getTextCharacters()
*/
public char[] getTextCharacters() {
@@ -369,7 +369,7 @@
}
/**
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getText()
*/
public String getText() {
@@ -389,7 +389,7 @@
}
/**
- * @return
+ * @return Returns int.
* @see javax.xml.stream.XMLStreamReader#getEventType()
*/
@@ -400,7 +400,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getNamespaceURI
*/
public String getNamespaceURI(int i) {
@@ -422,7 +422,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getNamespacePrefix
*/
public String getNamespacePrefix(int i) {
@@ -443,7 +443,7 @@
}
/**
- * @return
+ * @return Returns int.
* @see javax.xml.stream.XMLStreamReader#getNamespaceCount()
*/
public int getNamespaceCount() {
@@ -463,7 +463,7 @@
/**
* @param i
- * @return
+ * @return Returns boolean.
* @see javax.xml.stream.XMLStreamReader#isAttributeSpecified
*/
public boolean isAttributeSpecified(int i) {
@@ -484,7 +484,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getAttributeValue
*/
public String getAttributeValue(int i) {
@@ -507,7 +507,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getAttributeType
*/
public String getAttributeType(int i) {
@@ -528,7 +528,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getAttributePrefix
*/
public String getAttributePrefix(int i) {
@@ -554,7 +554,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getAttributeLocalName
*/
public String getAttributeLocalName(int i) {
@@ -577,7 +577,7 @@
/**
* @param i
- * @return
+ * @return Returns String.
* @see javax.xml.stream.XMLStreamReader#getAttributeNamespace
*/
public String getAttributeNamespace(int i) {
@@ -603,7 +603,7 @@
/**
* @param i
- * @return
+ * @return Returns QName.
* @see javax.xml.stream.XMLStreamReader#getAttributeName
*/
public QName getAttributeName(int i) {
@@ -622,7 +622,7 @@
}
/**
- * @return
+ * @return Returns int.
* @see javax.xml.stream.XMLStreamReader#getAttributeCount
*/
public int getAttributeCount() {
@@ -645,11 +645,11 @@
// todo
/**
- * Method getAttributeValue
+ * Method getAttributeValue.
*
* @param s
* @param s1
- * @return
+ * @return Returns String.
*/
public String getAttributeValue(String s, String s1) {
String returnString = null;
@@ -671,9 +671,9 @@
}
/**
- * Method isWhiteSpace
+ * Method isWhiteSpace.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isWhiteSpace() {
boolean b;
@@ -686,9 +686,9 @@
}
/**
- * Method isCharacters
+ * Method isCharacters.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isCharacters() {
boolean b;
@@ -701,9 +701,9 @@
}
/**
- * Method isEndElement
+ * Method isEndElement.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isEndElement() {
boolean b;
@@ -727,9 +727,9 @@
}
/**
- * Method isStartElement
+ * Method isStartElement.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isStartElement() {
boolean b;
@@ -742,10 +742,10 @@
}
/**
- * Method getNamespaceURI
+ * Method getNamespaceURI.
*
* @param s
- * @return
+ * @return Returns String.
*/
public String getNamespaceURI(String s) {
String returnString = null;
@@ -762,7 +762,7 @@
}
/**
- * Method close
+ * Method close.
*
* @throws XMLStreamException
*/
@@ -775,9 +775,9 @@
}
/**
- * Method hasNext
+ * Method hasNext.
*
- * @return
+ * @return Returns boolean.
* @throws XMLStreamException
*/
public boolean hasNext() throws XMLStreamException {
@@ -789,9 +789,9 @@
}
/**
- * nextTag - returns the next tag
+ * Returns the next tag.
*
- * @return
+ * @return Returns int.
* @throws org.apache.axis2.om.impl.llom.exception.OMStreamingException
*
* @throws XMLStreamException
@@ -812,7 +812,7 @@
}
/**
- * @return
+ * @return Returns String.
* @throws XMLStreamException
* @see javax.xml.stream.XMLStreamReader#getElementText()
*/
@@ -834,9 +834,9 @@
}
/**
- * Method next
+ * Method next.
*
- * @return
+ * @return Returns int.
* @throws XMLStreamException
*/
public int next() throws XMLStreamException {
@@ -886,10 +886,10 @@
}
/**
- * Method getProperty
+ * Method getProperty.
*
* @param s
- * @return
+ * @return Returns Object.
* @throws IllegalArgumentException
*/
public Object getProperty(String s) throws IllegalArgumentException {
@@ -897,11 +897,10 @@
}
/**
- * This is a very important method. this keeps the
- * navigator one step ahead and pushes the navigator
- * one event ahead. If the nextNode is null then navigable is set to false;
- * At the same time the parser and builder are set up for the upcoming event
- * generation
+ * This is a very important method. It keeps the navigator one step ahead
+ * and pushes it one event ahead. If the nextNode is null then navigable is
+ * set to false. At the same time the parser and builder are set up for
+ * the upcoming event generation.
*
* @throws XMLStreamException
*/
@@ -916,7 +915,7 @@
}
/**
- * Method updateNextNode
+ * Method updateNextNode.
*/
private void updateNextNode() {
if (navigator.isNavigable()) {
@@ -942,7 +941,7 @@
}
/**
- * Method updateCompleteStatus
+ * Method updateCompleteStatus.
*/
private void updateCompleteStatus() {
if (state == NAVIGABLE) {
@@ -971,36 +970,36 @@
}
/**
- * Method getNamespaceContext
+ * Method getNamespaceContext.
*
- * @return
+ * @return Returns NamespaceContext.
*/
public NamespaceContext getNamespaceContext() {
throw new UnsupportedOperationException();
}
/**
- * Method getEncoding
+ * Method getEncoding.
*
- * @return
+ * @return Returns String.
*/
public String getEncoding() {
return null;
}
/**
- * Method getLocation
+ * Method getLocation.
*
- * @return
+ * @return Returns Location.
*/
public Location getLocation() {
return null;
}
/**
- * Method getVersion
+ * Method getVersion.
*
- * @return
+ * @return Returns String.
*/
public String getVersion() {
return "1.0"; //todo put the constant
@@ -1008,45 +1007,45 @@
/**
- * Method isStandalone
+ * Method isStandalone.
*
- * @return
+ * @return Returns boolean.
*/
public boolean isStandalone() {
return true;
}
/**
- * Method standaloneSet
+ * Method standaloneSet.
*
- * @return
+ * @return Returns boolean.
*/
public boolean standaloneSet() {
return false;
}
/**
- * Method getCharacterEncodingScheme
+ * Method getCharacterEncodingScheme.
*
- * @return
+ * @return Returns String.
*/
public String getCharacterEncodingScheme() {
return "utf-8";
}
/**
- * Method getPITarget
+ * Method getPITarget.
*
- * @return
+ * @return Returns String.
*/
public String getPITarget() {
throw new UnsupportedOperationException();
}
/**
- * Method getPIData
+ * Method getPIData.
*
- * @return
+ * @return Returns String.
*/
public String getPIData() {
throw new UnsupportedOperationException();
@@ -1061,10 +1060,10 @@
*/
/**
- * Method generateEvents
+ * Method generateEvents.
*
* @param node
- * @return
+ * @return Returns int.
*/
private int generateEvents(OMNode node) {
int returnEvent = 0;
@@ -1090,10 +1089,10 @@
}
/**
- * Method generateElementEvents
+ * Method generateElementEvents.
*
* @param elt
- * @return
+ * @return Returns int.
*/
private int generateElementEvents(OMElement elt) {
int returnValue = START_ELEMENT;
@@ -1107,9 +1106,9 @@
}
/**
- * Method generateTextEvents
+ * Method generateTextEvents.
*
- * @return
+ * @return Returns int.
*/
private int generateTextEvents() {
return CHARACTERS;
@@ -1118,7 +1117,7 @@
/**
* Method generateCommentEvents
*
- * @return
+ * @return Returns int.
*/
private int generateCommentEvents() {
return COMMENT;
@@ -1127,7 +1126,7 @@
/**
* Method generateCdataEvents
*
- * @return
+ * @return Returns int.
*/
private int generateCdataEvents() {
return CDATA;
@@ -1140,10 +1139,10 @@
*/
/**
- * helper method
+ * helper method getCount.
*
* @param it
- * @return
+ * @return Returns int.
*/
private int getCount(Iterator it) {
int count = 0;
@@ -1157,11 +1156,11 @@
}
/**
- * Helper method
+ * Helper method getItemFromIterator.
*
* @param it
* @param index
- * @return
+ * @return Returns Object.
*/
private Object getItemFromIterator(Iterator it, int index) {
int count = 0;
@@ -1184,10 +1183,10 @@
}
/**
- * Helper method
+ * Helper method getQName.
*
* @param element
- * @return
+ * @return Returns QName.
*/
private QName getQName(OMElement element) {
QName returnName;
@@ -1210,7 +1209,7 @@
/**
* @param elt
* @param index
- * @return
+ * @return Returns OMAttribute.
*/
private OMAttribute getAttribute(OMElement elt, int index) {
OMAttribute returnAttrib = null;
Modified: webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMTextImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMTextImpl.java?rev=366248&r1=366247&r2=366248&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMTextImpl.java (original)
+++ webservices/axis2/trunk/java/modules/xml/src/org/apache/axis2/om/impl/llom/OMTextImpl.java Thu Jan 5 11:21:04 2006
@@ -44,36 +44,36 @@
protected boolean isBinary = false;
/**
- * Field contentID for the mime part used when serialising Binary stuff as
- * MTOM optimised
+ * Field contentID for the mime part used when serializing Binary stuff as
+ * MTOM optimized.
*/
private String contentID = null;
/**
* Field dataHandler contains the DataHandler
- * Declaring as Object to remove the depedency on
+ * Declaring as Object to remove the dependency on
* Javax.activation.DataHandler
*/
private Object dataHandlerObject = null;
/**
- * Field nameSpace used when serialising Binary stuff as MTOM optimised
+ * Field nameSpace used when serializing Binary stuff as MTOM optimized.
*/
protected OMNamespace ns = new OMNamespaceImpl(
"http://www.w3.org/2004/08/xop/include", "xop");
/**
- * Field localName used when serialising Binary stuff as MTOM optimised
+ * Field localName used when serializing Binary stuff as MTOM optimized.
*/
protected String localName = "Include";
/**
- * Field attributes used when serialising Binary stuff as MTOM optimised
+ * Field attributes used when serializing Binary stuff as MTOM optimized.
*/
protected OMAttribute attribute;
/**
- * Constructor OMTextImpl
+ * Constructor OMTextImpl.
*
* @param s
*/
@@ -84,7 +84,7 @@
/**
* @param s
- * @param nodeType - OMText can handler CHARACTERS, SPACES, CDATA and ENTITY REFERENCES.
+ * @param nodeType - OMText can handle CHARACTERS, SPACES, CDATA and ENTITY REFERENCES.
* Constants for this can be found in OMNode.
*/
public OMTextImpl(String s, int nodeType) {
@@ -93,7 +93,7 @@
}
/**
- * Constructor OMTextImpl
+ * Constructor OMTextImpl.
*
* @param parent
* @param text
@@ -113,8 +113,7 @@
}
/**
- * @param s -
- * base64 encoded String representation of Binary
+ * @param s - base64 encoded String representation of Binary
* @param mimeType of the Binary
*/
public OMTextImpl(String s, String mimeType, boolean optimize) {
@@ -161,7 +160,7 @@
* @param parent
* @param builder Used when the builder is encountered with a XOP:Include tag
* Stores a reference to the builder and the content-id. Supports
- * deffered parsing of MIME messages
+ * deferred parsing of MIME messages.
*/
public OMTextImpl(String contentID, OMElement parent,
OMXMLParserWrapper builder) {
@@ -183,7 +182,7 @@
}
/**
- * Writes the relevant output
+ * Writes the relevant output.
*
* @param omOutput
* @throws XMLStreamException
@@ -201,7 +200,7 @@
}
/**
- * Returns the value
+ * Returns the value.
*/
public String getText() throws OMException {
if (this.value != null) {
@@ -244,8 +243,8 @@
/**
- * To get the datahandler
- * @return javax.activation.DataHandler
+ * Gets the datahandler.
+ * @return Returns javax.activation.DataHandler
*/
public Object getDataHandler() {
/*
@@ -372,7 +371,7 @@
}
/**
- * Method serializeAttribute
+ * Method serializeAttribute.
*
* @param attr
* @param omOutput
@@ -402,7 +401,7 @@
}
/**
- * Method serializeNamespace
+ * Method serializeNamespace.
*
* @param namespace
* @param omOutput
@@ -420,7 +419,7 @@
}
/**
- * Slightly different implementation of the discard method
+ * A slightly different implementation of the discard method.
*
* @throws OMException
*/