SMILA (incubation) API documentation

org.eclipse.smila.datamodel.id.stax
Class IdReader

java.lang.Object
  extended by org.eclipse.smila.datamodel.id.stax.IdReader

public class IdReader
extends java.lang.Object

StAX based Id reader. Should give better performance than the DOM based IdParser.

Author:
jschumacher

Constructor Summary
IdReader()
          create default instance.
IdReader(IdFactory idFactory)
           
 
Method Summary
 Id readId(javax.xml.stream.XMLStreamReader staxReader)
          read Id from the XML stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdReader

public IdReader()
create default instance.


IdReader

public IdReader(IdFactory idFactory)
Parameters:
idFactory - Id factory to use.
Method Detail

readId

public Id readId(javax.xml.stream.XMLStreamReader staxReader)
          throws javax.xml.stream.XMLStreamException
read Id from the XML stream. The stream must be currently at the Id start tag.

Parameters:
staxReader - source XML stream
Returns:
Id read from stream or null, if stream is not currently at a Id start tag.
Throws:
javax.xml.stream.XMLStreamException - StAX error.

SMILA (incubation) API documentation