Java XML library. A really cool one. Obviously.

Root/Intermediate[X='Passed'] creates

<Root> <Intermediate>Value</Intermediate> </Root>

instead of <Root> <Intermediate> <X>Passed</X> Value </Intermediate> </Root>

Congratulations to the elegant solution.

May I please suggest though that the XPath implementation be abstracted and made plugable. The JDK implementation is not simply slow but horribly slow. The implementation I use is xjpath (http://commons.apache.org/proper/commons-jxpath/) and on my workloads it is approx. 40 times faster than JDK.

Regards Nikolay

The behaviour of XMLBeam when accessing whitespace-only text nodes with text() has changed in 1.4.20.

Sample test code:

public class TextNodeTest {

    interface Item {
        @XBRead("/item/text()")
        String getText();
    }

    @Test
    public void testWhitespaceOnlyTextNode() {
        final Item item = new XBProjector().onXMLString("<item> </item>").createProjection(Item.class);
        assertEquals(" ", item.getText());
    }
}

With 1.4.19, item.getText() returns " " (single space), and the test succeeds. With 1.4.20, item.getText() returns null, and the test fails.

The same can be reproduced for any text nodes that contain nothing but a non-empty sequence of whitespace characters like space, tab and newline.

In our application, we can't change the XML, and we need to know precisely which text is present (even if it's only spaces). Is there any way with 1.4.20 to get the original contents of the part between <item> and </item>?

@XBAuto("/r:xml/y:example/content") Hello: Does a path similar to this format support conversion? Does the path support special symbols? Thank。

I am using xmlbeam 1.4.13 with the newest JDK 9.0.1. In my projection interface I have a method with return type Optional<String>. If I call this method, an IllegalArgumentException is raised (from line 362 in ProjectionInvocationHandler.ReadInvocationHandler).

This is due to the control flow in that class: With the DefaultTypeConverter in use, an Optional return type is deemed unconvertable (isConvertable == false). Consequentially, lines 324-326 will not get executed, the lines that are supposed to deal with an Optional.

My fix for now is to add an Optional conversion to the type converter:

private static void fixOptionalTypeConversion(XBProjector projector) {
  DefaultTypeConverter typeConverter = projector.config().getTypeConverterAs(DefaultTypeConverter.class);
  typeConverter.setConversionForType(Optional.class, new DefaultTypeConverter.Conversion<>(null) {
    @Override
    public Optional convert(String data) {
      return Optional.ofNullable(data);
    }
  });
}

With that fix, the projection interface method returns an Optional as expected.

Can you confirm this bug? I noticed the test repository for Java 8 having some tests for the Optional return type that pretty much resemble my situation.

These tests fail if I run them against xmlbeam 1.4.13 (with JDKs 9.0.1 and 1.8.0_152). Are they still relevant and maintained? I noticed in the pom.xml that the project depends on xmlbeams 1.4.7-SNAPSHOT.

Currently projection interfaces need to be public (due to XBProjector.ensureIsValidProjectionInterface(…) explicitly checking). However, simply making the interface accessible should do the trick in such cases. In case that in turn throws an exception, a similar rejection exception could be raised.

For example, to parse a Date I need to register a Converter class.

It would be slicker if I could put a @DateFormat("...some simpledateformat string...") annotation on the interface field, and XMLBeam would use that to parse the date.

Same for ints, etc.

Assume you read an XML document with the following element:

<version>1.4.0.RELEASE</version>

It would be cool if there was a way to parse the String value of the element into a value object directly:

class ArtifactVersion {

  public ArtifactVersion(String source) { … }
  public static ArtifactVersion parse(String source) { … }
}

So assuming the value type adheres to a certain convention (a static factory method or a constructor taking a string - I'd slightly prefer the former), XmlBeam could return an instance of that type right from a projection:

interface Pom {

  @XBRead("/version")
  ArtifactVersion getVersion();
}

On the writing side of things I guess simply calling toString() would do the trick as one can expect the String representation to be equal to the initially parsed format (see this blog for justification).

ProjectionFactory has been made package private in 1.4.11 which is a breaking API change and an unfortunate one as it's kind of neat to be able to only hold a reference to the factory rather than XBProjector. Was this by accident?

I'll have to change Spring Data's XmlBeamHttpMessageConverter to make it compatible with the latest bugfix releases. Any chance you make this interface public again?

Same error as Root/Intermediate[X/Y='Passed']

Relevant error message is: ... Caused by: org.xmlbeam.util.intern.duplex.XBXPathExprNotAllowedForWriting: Not expetced here.: Node PathExpr is not supported for writing expressions in line 1 col 18 to 21 ...

Hi !

I inmediately fall in love with your project, and start using it to write/parse XML content in our application, but found one xml file that's blocking me completely, as i feel unable to make it worl.

May i get some help from you ?

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Body><ns1:storeTokenResponse xmlns:ns1="http://recurring.services.adyen.com">
<ns1:result><additionalData xmlns="http://recurring.services.adyen.com" xsi:nil="true" /><alias xmlns="http://recurring.services.adyen.com">B133243153928547</alias><aliasType xmlns="http://recurring.services.adyen.com">Default</aliasType><params xmlns="http://recurring.services.adyen.com" xsi:nil="true" /><pspEchoData xmlns="http://recurring.services.adyen.com" xsi:nil="true" /><pspReference xmlns="http://recurring.services.adyen.com">8514873382743402</pspReference><recurringDetailReference xmlns="http://recurring.services.adyen.com">8414873382748121</recurringDetailReference><redirectType xmlns="http://recurring.services.adyen.com" xsi:nil="true" /><redirectUrl xmlns="http://recurring.services.adyen.com" xsi:nil="true" /><result xmlns="http://recurring.services.adyen.com">Success</result></ns1:result></ns1:storeTokenResponse></soap:Body></soap:Envelope>

This is the xml itself, as arrives from the network, but all i can get is to retrieve the Body tag. From there, everything is null.

This is my Beam :

public interface SOAPResponse {

    @XBRead("/soap:Envelope/soap:Body")
    Body getBody();

    interface Body {
        @XBRead("./ns1:storeTokenResponse/ns1:result")
        Result getResult();
    }

    interface Result {

        @XBRead("./ns1:alias")
        String getAlias();

        @XBRead("./ns1:aliasType")
        String getAliasType();

        @XBRead("./ns1:pspReference")
        String getPspReference();

        @XBRead("./ns1:recurringDetailReference")
        String getRecurringDetailReference();

        @XBRead("./ns1:result")
        String getResult();

    }
}

and this is my test-code

    @Test
    public void canParseXML() throws Exception{

        String content = new String(Files.readAllBytes(Paths.get("soap.xml")));

        SOAPResponse soapResponse = projector.onXMLString(content.trim())
                                             .createProjection(SOAPResponse.class);

        Assert.assertNotNull(soapResponse.getBody());

        Result result = soapResponse.getBody().getResult();

        Assert.assertEquals("B133243153928547",result.getAlias());
        Assert.assertEquals("Default",result.getAliasType());
        Assert.assertEquals("8514873382743402",result.getPspReference());
        Assert.assertEquals("8414873382748121",result.getRecurringDetailReference());
        Assert.assertEquals("Success",result.getResult());

    }

And yes, by using XPath online on the xml, the PspReference attributes is retrieved by using "ns1" prefix.

Thanks a lot, i really appreciate your project.

I'm seeing an issue where when using @XBWrite the last element in the path isn't created.

Here's a test case to explain what I mean.

import static org.junit.Assert.assertEquals;

import org.junit.Test;
import org.xmlbeam.XBProjector;
import org.xmlbeam.XBProjector.Flags;
import org.xmlbeam.annotation.XBWrite;

public class TestSetChildOnEmptyParent {

	public interface Child {
		@XBWrite("ChildData")
		void setData(String data);
	}
	
	public interface ParentWithRootElement {
		@XBWrite("Root/ParentData")
		void setData(String data);
		
		@XBWrite("Root/Child")
		void setChild(Child child);
	}

	@Test
	public void testSetChildProjectionEmptyParent() {
		XBProjector projector = new XBProjector(Flags.TO_STRING_RENDERS_XML);
		
		ParentWithRootElement parent = projector.projectEmptyDocument(ParentWithRootElement.class);
		
		Child child = projector.projectEmptyDocument(Child.class);
		child.setData("child data...");		
		
		parent.setChild(child);  
		
		System.out.println("Result: " + parent);
		
		// Doesn't generate <Child> intermediate level
		assertEquals( 
				  "<Root>\n"
				+ "   <Child>\n"
				+ "      <ChildData>child data...</ChildData>\n"
				+ "   </Child>\n"
				+ "</Root>",
				parent.toString());
	}
	
}

I'm seeing this error while trying to set a child projection onto a parent projection where the @XBWrite segment is the document root.

Here's a test case:

import static org.junit.Assert.assertEquals;

import org.junit.Test;
import org.xmlbeam.XBProjector;
import org.xmlbeam.XBProjector.Flags;
import org.xmlbeam.annotation.XBWrite;

public class TestSetChildUnderDocumentRoot {

	public interface Child {
		@XBWrite("ChildData")
		void setData(String data);
	}
	
	public interface ParentNoRootElement {

		@XBWrite("Child")
		void setChild(Child child);
	}
		
	@Test
	public void testSetChildOnParentAsDocumentRoot() {
		XBProjector projector = new XBProjector(Flags.TO_STRING_RENDERS_XML);
		
		ParentNoRootElement parent = projector.projectEmptyDocument(ParentNoRootElement.class);
		
		Child child = projector.projectEmptyDocument(Child.class);
		child.setData("child data...");
		
		parent.setChild(child);  
		
		/* Throws:
		java.lang.ClassCastException: com.sun.org.apache.xerces.internal.dom.DocumentImpl cannot be cast to org.w3c.dom.Element
			at org.xmlbeam.util.intern.DOMHelper.replaceElement(DOMHelper.java:511)
			at org.xmlbeam.ProjectionInvocationHandler$WriteInvocationHandler.invokeProjection(ProjectionInvocationHandler.java:669)
			at org.xmlbeam.ProjectionInvocationHandler$ProjectionMethodInvocationHandler.invoke(ProjectionInvocationHandler.java:206)
			at org.xmlbeam.ProjectionInvocationHandler.invoke(ProjectionInvocationHandler.java:879)
			at com.sun.proxy.$Proxy5.setChild(Unknown Source)
		 */
		
		System.out.println("Result: " + parent);
		
		assertEquals(
				  "<Child>\n"
				+ "   <ChildData>child data...</ChildData>\n"
				+ "</Child>",
				parent.toString());
	}
}

I just created an example and request for enhancement in Spring Framework to integrate XMLBeam with Spring MVC as it's uber useful in case you'd like to implement more lenient data binding from XML (as you might want to be able to adapt to slight document structure changes without changing consuming code.

Thinking through this I wondered whether there's an opportunity to provide the data projecting approach to JSON documents, too, using JSONPath instead of XPath as JSON for better or for worse has become the lingua france of integration APIs. I know this might be a stretch but didn't actually imagine a better place to at least ask, as I think it would be well received.