Search code examples
javaxml-parsingstax

Read XML String using StAX


I am using stax for the first time to parse an XML String. I have found some examples but can't get my code to work. This is the latest version of my code:

public class AddressResponseParser
{
    private static final String STATUS = "status";
    private static final String ADDRESS_ID = "address_id";
    private static final String CIVIC_ADDRESS = "civic_address";

    String status = null;
    String addressId = null;
    String civicAddress = null;

    public static AddressResponse parseAddressResponse(String response)
    {

        try
        {
            byte[] byteArray = response.getBytes("UTF-8");
            ByteArrayInputStream inputStream = new ByteArrayInputStream(byteArray);
            XMLInputFactory inputFactory = XMLInputFactory.newInstance();
            XMLStreamReader reader = inputFactory.createXMLStreamReader(inputStream);

            while (reader.hasNext())
            {
                int event = reader.next();

                if (event == XMLStreamConstants.START_ELEMENT)
                {
                    String element = reader.getLocalName();

                    if (element.equals(STATUS))
                    {
                        status = reader.getElementText();
                        continue;
                    }

                    if (element.equals(ADDRESS_ID))
                    {
                        addressId = reader.getText();
                        continue;
                    }

                    if (element.equals(CIVIC_ADDRESS))
                    {
                        civicAddress = reader.getText();
                        continue;
                    }
                }
            }
        }
        catch (Exception e)
        {
            log.error("Couldn't parse AddressResponse", e);
        }
    }
}

I've put watches on "event" and "reader.getElementText()". When the code is stopped on

String element = reader.getLocalName();

the "reader.getElementText()" value is displayed, but as soon as it moves away from that line it can't be evaluated. When the code is stopped on:

status = reader.getElementText();

the "element" watch displays the correct value. Finally, when I step the code one more line, I catch this exception:

(com.ctc.wstx.exc.WstxParsingException) com.ctc.wstx.exc.WstxParsingException: Current state not START_ELEMENT
 at [row,col {unknown-source}]: [1,29]

I've tried using status = reader.getText(); instead, but then I get this exception:

(java.lang.IllegalStateException) java.lang.IllegalStateException: Not a textual event (END_ELEMENT)

Can somebody point out what I'm doing wrong??

EDIT:

Adding JUnit code used to test:

public class AddressResponseParserTest
{
    private String status = "OK";
    private String address_id = "123456";
    private String civic_address = "727";

    @Test
    public void testAddressResponseParser() throws UnsupportedEncodingException, XMLStreamException
    {
        AddressResponse parsedResponse = AddressResponseParser.parseAddressResponse(this.responseXML());

        assertEquals(this.status, parsedResponse.getStatus());

        assertEquals(this.address_id, parsedResponse.getAddress()
                .getAddressId());
        assertEquals(this.civic_address, parsedResponse.getAddress()
                .getCivicAddress());
    }

    private String responseXML()
    {
        StringBuffer buffer = new StringBuffer();

        buffer.append("<response>");
        buffer.append("<status>OK</status>");
        buffer.append("<address>");
        buffer.append("<address_id>123456</address_id>");
        buffer.append("<civic_address>727</civic_address>");
        buffer.append("</address>");
        buffer.append("</response>");

        return buffer.toString();
    }
}

Solution

  • I found a solution that uses XMLEventReader instead of XMLStreamReader:

    public MyObject parseXML(String xml)
        throws XMLStreamException, UnsupportedEncodingException
    {
        byte[] byteArray = xml.getBytes("UTF-8");
        ByteArrayInputStream inputStream = new ByteArrayInputStream(byteArray);
        XMLInputFactory inputFactory = XMLInputFactory.newInstance();
        XMLEventReader reader = inputFactory.createXMLEventReader(inputStream);
    
        MyObject object = new MyObject();
    
        while (reader.hasNext())
        {
            XMLEvent event = (XMLEvent) reader.next();
    
            if (event.isStartElement())
            {
                StartElement element = event.asStartElement();
    
                if (element.getName().getLocalPart().equals("ElementOne"))
                {
                    event = (XMLEvent) reader.next();
    
                    if (event.isCharacters())
                    {
                         String elementOne = event.asCharacters().getData();
                         object.setElementOne(elementOne);
                    }
                    continue;
                }
                if (element.getName().getLocalPart().equals("ElementTwo"))
                {
                    event = (XMLEvent) reader.next();
                    if (event.isCharacters())
                    {
                         String elementTwo = event.asCharacters().getData();
                         object.setElementTwo(elementTwo);
                    }
                    continue;
                }
            }
        }
    
        return object;
    }
    

    I would still be interested in seeing a solution using XMLStreamReader.