You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ws.apache.org by ve...@apache.org on 2012/07/08 17:12:12 UTC
svn commit: r1358755 - in /webservices/commons/trunk/modules/axiom/modules:
axiom-api/src/main/java/org/apache/axiom/om/
axiom-api/src/main/java/org/apache/axiom/om/impl/
axiom-api/src/main/java/org/apache/axiom/om/impl/builder/
axiom-common-impl/src/m...
Author: veithen
Date: Sun Jul 8 15:12:11 2012
New Revision: 1358755
URL: http://svn.apache.org/viewvc?rev=1358755&view=rev
Log:
Ensure that getNextOMSibling throws an appropriate exception if the next sibling is not available because the parent node has been discarded.
Added:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java (with props)
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/OMContainerEx.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXBuilder.java
webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IContainer.java
webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IParentNode.java
webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMNodeHelper.java
webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/AttrImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentFragmentImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMDocumentImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java
webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/node/TestGetNextOMSiblingAfterDiscard.java
Added: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java?rev=1358755&view=auto
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java (added)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java Sun Jul 8 15:12:11 2012
@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.axiom.om;
+
+import javax.xml.stream.XMLStreamWriter;
+
+/**
+ * Exception indicating that a requested node cannot be returned because it is no longer available.
+ * A node may become unavailable because it has been consumed by a method such as
+ * {@link OMContainer#serializeAndConsume(XMLStreamWriter)} or
+ * {@link OMContainer#getXMLStreamReaderWithoutCaching()}, or because one of its ancestors has been
+ * discarded using {@link OMNode#discard()}.
+ */
+public class NodeUnavailableException extends OMException {
+ private static final long serialVersionUID = -9034004432518092807L;
+
+ public NodeUnavailableException() {
+ }
+}
Propchange: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/NodeUnavailableException.java
------------------------------------------------------------------------------
svn:eol-style = native
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/OMContainerEx.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/OMContainerEx.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/OMContainerEx.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/OMContainerEx.java Sun Jul 8 15:12:11 2012
@@ -29,6 +29,8 @@ import org.apache.axiom.om.OMNode;
public interface OMContainerEx extends OMContainer {
public void setComplete(boolean state);
+ void discarded();
+
void buildNext();
/**
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXBuilder.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXBuilder.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXBuilder.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXBuilder.java Sun Jul 8 15:12:11 2012
@@ -335,6 +335,18 @@ public abstract class StAXBuilder implem
parserNext();
}
+ // Mark nodes as discarded
+ current = lastNode;
+ while (true) {
+ if (!current.isComplete()) {
+ ((OMContainerEx)current).discarded();
+ }
+ if (current == element) {
+ break;
+ }
+ current = (OMElement)current.getParent();
+ }
+
//at this point we are safely at the end_element event of the element we discarded
lastNode = element.getPreviousOMSibling();
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IContainer.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IContainer.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IContainer.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IContainer.java Sun Jul 8 15:12:11 2012
@@ -22,9 +22,5 @@ import org.apache.axiom.om.OMNode;
import org.apache.axiom.om.impl.OMContainerEx;
public interface IContainer extends OMContainerEx, IParentNode {
- int INCOMPLETE = 0;
- int COMPLETE = 1;
- int DISCARDED = 2;
-
OMNode getLastKnownOMChild();
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IParentNode.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IParentNode.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IParentNode.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/IParentNode.java Sun Jul 8 15:12:11 2012
@@ -30,7 +30,12 @@ import org.w3c.dom.DocumentFragment;
* (such as DOOM's {@link Attr} and {@link DocumentFragment} implementations).
*/
public interface IParentNode {
+ int INCOMPLETE = 0;
+ int COMPLETE = 1;
+ int DISCARDED = 2;
+
OMXMLParserWrapper getBuilder();
+ int getState();
boolean isComplete();
void buildNext();
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMNodeHelper.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMNodeHelper.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMNodeHelper.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-common-impl/src/main/java/org/apache/axiom/om/impl/common/OMNodeHelper.java Sun Jul 8 15:12:11 2012
@@ -18,6 +18,7 @@
*/
package org.apache.axiom.om.impl.common;
+import org.apache.axiom.om.NodeUnavailableException;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMNode;
@@ -25,14 +26,21 @@ public final class OMNodeHelper {
private OMNodeHelper() {}
public static OMNode getNextOMSibling(IChildNode node) throws OMException {
- if (node.getNextOMSiblingIfAvailable() == null) {
+ OMNode nextSibling = node.getNextOMSiblingIfAvailable();
+ if (nextSibling == null) {
IParentNode parent = node.getIParentNode();
if (parent != null && parent.getBuilder() != null) {
- while (!parent.isComplete() && node.getNextOMSiblingIfAvailable() == null) {
- parent.buildNext();
+ switch (parent.getState()) {
+ case IParentNode.DISCARDED:
+ throw new NodeUnavailableException();
+ case IParentNode.INCOMPLETE:
+ do {
+ parent.buildNext();
+ } while (parent.getState() == IParentNode.INCOMPLETE
+ && (nextSibling = node.getNextOMSiblingIfAvailable()) == null);
}
}
}
- return node.getNextOMSiblingIfAvailable();
+ return nextSibling;
}
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/AttrImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/AttrImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/AttrImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/AttrImpl.java Sun Jul 8 15:12:11 2012
@@ -472,6 +472,10 @@ public class AttrImpl extends RootNode i
return null;
}
+ public final int getState() {
+ return COMPLETE;
+ }
+
public final boolean isComplete() {
return true;
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentFragmentImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentFragmentImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentFragmentImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentFragmentImpl.java Sun Jul 8 15:12:11 2012
@@ -90,6 +90,10 @@ public class DocumentFragmentImpl extend
return null;
}
+ public final int getState() {
+ return COMPLETE;
+ }
+
public final boolean isComplete() {
return true;
}
@@ -100,6 +104,10 @@ public class DocumentFragmentImpl extend
}
}
+ public final void discarded() {
+ throw new UnsupportedOperationException();
+ }
+
public final void build() {
// A document fragment doesn't have a builder
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/DocumentImpl.java Sun Jul 8 15:12:11 2012
@@ -602,6 +602,10 @@ public class DocumentImpl extends RootNo
return builder;
}
+ public final int getState() {
+ return state;
+ }
+
public final boolean isComplete() {
return state == COMPLETE;
}
@@ -610,6 +614,10 @@ public class DocumentImpl extends RootNo
state = complete ? COMPLETE : INCOMPLETE;
}
+ public final void discarded() {
+ state = DISCARDED;
+ }
+
public final void build() {
OMContainerHelper.build(this);
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-dom/src/main/java/org/apache/axiom/om/impl/dom/ElementImpl.java Sun Jul 8 15:12:11 2012
@@ -1335,6 +1335,10 @@ public class ElementImpl extends ParentN
return builder;
}
+ public final int getState() {
+ return state;
+ }
+
public final boolean isComplete() {
return state == COMPLETE;
}
@@ -1351,6 +1355,10 @@ public class ElementImpl extends ParentN
}
}
+ public final void discarded() {
+ state = DISCARDED;
+ }
+
public OMNode detach() throws OMException {
if (isComplete() && !getParent().isComplete() && getNextOMSiblingIfAvailable() == null) {
// Special case: the node is complete, but the next node has not yet been created.
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMDocumentImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMDocumentImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMDocumentImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMDocumentImpl.java Sun Jul 8 15:12:11 2012
@@ -136,6 +136,10 @@ public class OMDocumentImpl extends OMSe
}
}
+ public int getState() {
+ return state;
+ }
+
public boolean isComplete() {
return state == COMPLETE;
}
@@ -149,6 +153,10 @@ public class OMDocumentImpl extends OMSe
state = complete ? COMPLETE : INCOMPLETE;
}
+ public void discarded() {
+ state = DISCARDED;
+ }
+
public void addChild(OMNode child) {
addChild(child, false);
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMElementImpl.java Sun Jul 8 15:12:11 2012
@@ -711,6 +711,10 @@ public class OMElementImpl extends OMNod
OMContainerHelper.buildNext(this);
}
+ public int getState() {
+ return state;
+ }
+
public boolean isComplete() {
return state == COMPLETE;
}
@@ -728,6 +732,10 @@ public class OMElementImpl extends OMNod
}
}
+ public void discarded() {
+ state = DISCARDED;
+ }
+
public XMLStreamReader getXMLStreamReader() {
return getXMLStreamReader(true);
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-impl/src/main/java/org/apache/axiom/om/impl/llom/OMSourcedElementImpl.java Sun Jul 8 15:12:11 2012
@@ -915,6 +915,14 @@ public class OMSourcedElementImpl extend
return super.handleNamespace(qname);
}
+ public int getState() {
+ if (isExpanded) {
+ return super.getState();
+ } else {
+ return COMPLETE;
+ }
+ }
+
public boolean isComplete() {
if (isExpanded) {
return super.isComplete();
@@ -1051,6 +1059,11 @@ public class OMSourcedElementImpl extend
}
}
+ public void discarded() {
+ // TODO: will we ever get here?
+ super.discarded();
+ }
+
public SAXSource getSAXSource(boolean cache) {
return super.getSAXSource(cache);
}
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/node/TestGetNextOMSiblingAfterDiscard.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/node/TestGetNextOMSiblingAfterDiscard.java?rev=1358755&r1=1358754&r2=1358755&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/node/TestGetNextOMSiblingAfterDiscard.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-testsuite/src/main/java/org/apache/axiom/ts/om/node/TestGetNextOMSiblingAfterDiscard.java Sun Jul 8 15:12:11 2012
@@ -20,6 +20,7 @@ package org.apache.axiom.ts.om.node;
import java.io.StringReader;
+import org.apache.axiom.om.NodeUnavailableException;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMMetaFactory;
@@ -40,9 +41,8 @@ public class TestGetNextOMSiblingAfterDi
element.discard();
try {
child.getNextOMSibling();
- fail("Expected OMException");
- } catch (Exception ex) {
- // TODO: we should get an OMException here; right now we get an IllegalStateException
+ fail("Expected NodeUnavailableException");
+ } catch (NodeUnavailableException ex) {
// Expected
}
}