eu.cdevreeze.yaidom.convert

StaxConversions

object StaxConversions extends YaidomToStaxEventsConversions with StaxEventsToYaidomConversions

Conversions between yaidom nodes and StAX events.

These conversions are used in implementations of yaidom XML parsers and printers. They are also useful in application code.

Linear Supertypes
StaxEventsToYaidomConversions, ConverterToDocument[IndexedSeq[XMLEvent]], YaidomToStaxEventsConversions, DocumentConverter[(XMLEventFactory) ⇒ IndexedSeq[XMLEvent]], ElemConverter[(XMLEventFactory) ⇒ IndexedSeq[XMLEvent]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. StaxConversions
  2. StaxEventsToYaidomConversions
  3. ConverterToDocument
  4. YaidomToStaxEventsConversions
  5. DocumentConverter
  6. ElemConverter
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. final def asIterator(xmlEventReader: XMLEventReader): Iterator[XMLEvent]

    Convenience method to turn an XMLEventReader into a Scala Iterator of XMLEvent objects.

    Convenience method to turn an XMLEventReader into a Scala Iterator of XMLEvent objects.

    Definition Classes
    StaxEventsToYaidomConversions
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def convertComment(comment: Comment, xmlEventFactory: XMLEventFactory): IndexedSeq[XMLEvent]

    Converts a yaidom Comment to a sequence of XMLEvent instances, given an XMLEventFactory.

    Converts a yaidom Comment to a sequence of XMLEvent instances, given an XMLEventFactory.

    Definition Classes
    YaidomToStaxEventsConversions
  10. final def convertDocument(doc: Document): (XMLEventFactory) ⇒ IndexedSeq[XMLEvent]

    Converts a yaidom Document to a function from XMLEventFactorys to sequences of XMLEvent instances

    Converts a yaidom Document to a function from XMLEventFactorys to sequences of XMLEvent instances

    Definition Classes
    YaidomToStaxEventsConversionsDocumentConverter
  11. final def convertElem(elm: Elem, xmlEventFactory: XMLEventFactory, parentScope: Scope): IndexedSeq[XMLEvent]

    Converts a yaidom Elem to a sequence of XMLEvent instances, given an XMLEventFactory.

    Converts a yaidom Elem to a sequence of XMLEvent instances, given an XMLEventFactory. The given parent scope is used, that is, the namespace declarations of the outer "start element event" is parentScope.relativize(elm.scope).

    Definition Classes
    YaidomToStaxEventsConversions
  12. final def convertElem(elm: Elem): (XMLEventFactory) ⇒ IndexedSeq[XMLEvent]

    Converts a yaidom Elem to a function from XMLEventFactorys to sequences of XMLEvent instances.

    Converts a yaidom Elem to a function from XMLEventFactorys to sequences of XMLEvent instances. The assumed parent scope is the empty scope, so the namespace declarations of the outer "start element event" follow from the scope of the passed Elem.

    Definition Classes
    YaidomToStaxEventsConversionsElemConverter
  13. final def convertNode(node: Node, xmlEventFactory: XMLEventFactory, parentScope: Scope): IndexedSeq[XMLEvent]

    Converts a yaidom node to a sequence of XMLEvent instances, given an XMLEventFactory.

    Converts a yaidom node to a sequence of XMLEvent instances, given an XMLEventFactory. The given parent scope is used, in case the node is an Elem.

    Definition Classes
    YaidomToStaxEventsConversions
  14. final def convertProcessingInstruction(processingInstruction: ProcessingInstruction, xmlEventFactory: XMLEventFactory): IndexedSeq[XMLEvent]

    Converts a yaidom ProcessingInstruction to a sequence of XMLEvent instances, given an XMLEventFactory.

    Converts a yaidom ProcessingInstruction to a sequence of XMLEvent instances, given an XMLEventFactory.

    Definition Classes
    YaidomToStaxEventsConversions
  15. final def convertText(text: Text, xmlEventFactory: XMLEventFactory): IndexedSeq[XMLEvent]

    Converts a yaidom Text to a sequence of XMLEvent instances, given an XMLEventFactory.

    Converts a yaidom Text to a sequence of XMLEvent instances, given an XMLEventFactory.

    Definition Classes
    YaidomToStaxEventsConversions
  16. final def convertToComment(event: Comment): Comment

    Converts a StAX Comment event to a yaidom Comment

    Converts a StAX Comment event to a yaidom Comment

    Definition Classes
    StaxEventsToYaidomConversions
  17. final def convertToDocument(v: Iterator[XMLEvent]): Document

    Converts the given iterator of XMLEvent instances to a yaidom Document.

    Converts the given iterator of XMLEvent instances to a yaidom Document.

    First drops events until a "start document" event is found. After conversion, no "start/end document/element" events may be left.

    Definition Classes
    StaxEventsToYaidomConversions
  18. final def convertToDocument(v: IndexedSeq[XMLEvent]): Document

    Converts the given sequence of XMLEvent instances to a yaidom Document.

    Converts the given sequence of XMLEvent instances to a yaidom Document. Invokes convertToDocument(v.iterator).

    Definition Classes
    StaxEventsToYaidomConversionsConverterToDocument
  19. final def convertToElem(v: Iterator[XMLEvent], parentScope: Scope): Elem

    Converts the given iterator of XMLEvent instances to a yaidom Elem.

    Converts the given iterator of XMLEvent instances to a yaidom Elem.

    First drops events until a "start element" event is found. After conversion, no "start/end element" events may be left. The given parent scope is used.

    Be careful: the namespaces inherited by the "start element event", if any, are ignored! In other words, the ancestry of the passed events is entirely ignored. This may cause an exception to be thrown, if there are indeed such namespaces, unless they are a subset of the passed parent scope.

    Definition Classes
    StaxEventsToYaidomConversions
  20. final def convertToElem(v: IndexedSeq[XMLEvent], parentScope: Scope): Elem

    Converts the given sequence of XMLEvent instances to a yaidom Elem.

    Converts the given sequence of XMLEvent instances to a yaidom Elem. Invokes convertToElem(v.iterator, parentScope).

    Be careful: the namespaces inherited by the "start element event", if any, are ignored! In other words, the ancestry of the passed events is entirely ignored. This may cause an exception to be thrown, if there are indeed such namespaces, unless they are a subset of the passed parent scope.

    Definition Classes
    StaxEventsToYaidomConversions
  21. final def convertToEntityRef(event: EntityReference): EntityRef

    Converts a StAX EntityReference event to a yaidom EntityRef

    Converts a StAX EntityReference event to a yaidom EntityRef

    Definition Classes
    StaxEventsToYaidomConversions
  22. final def convertToEventWithEndStateIterator(events: Iterator[XMLEvent]): Iterator[EventWithEndState]

    Converts the iterator of XMLEvents to an iterator of EventWithEndState objects.

    Converts the iterator of XMLEvents to an iterator of EventWithEndState objects. This method can also be used in streaming scenarios, where only chunks of a large XML stream are kept in memory at any moment in time.

    Definition Classes
    StaxEventsToYaidomConversions
  23. final def convertToProcessingInstruction(event: ProcessingInstruction): ProcessingInstruction

    Converts a StAX ProcessingInstruction event to a yaidom ProcessingInstruction

    Converts a StAX ProcessingInstruction event to a yaidom ProcessingInstruction

    Definition Classes
    StaxEventsToYaidomConversions
  24. final def convertToText(event: Characters): Text

    Converts a StAX Characters event to a yaidom Text

    Converts a StAX Characters event to a yaidom Text

    Definition Classes
    StaxEventsToYaidomConversions
  25. def encoding: String

    Returns encoding used in the createStartDocument call.

    Returns encoding used in the createStartDocument call. Can be overridden.

    Definition Classes
    YaidomToStaxEventsConversions
  26. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  28. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  36. final def takeDocument(eventStateIterator: BufferedIterator[EventWithEndState]): DocumentWithRemainingEventStates

    Given a buffered iterator of EventWithEndState objects, converts the (initial) events to a Document.

    Given a buffered iterator of EventWithEndState objects, converts the (initial) events to a Document. The remaining event end states are also returned in the result. The first event must be a StartDocument event, or else an exception is thrown.

    The input iterator should come from a call to method convertToEventWithEndStateIterator.

    Definition Classes
    StaxEventsToYaidomConversions
  37. final def takeElem(eventStateIterator: BufferedIterator[EventWithEndState]): ElemWithRemainingEventStates

    Given a buffered iterator of EventWithEndState objects, converts the (initial) events to a Elem.

    Given a buffered iterator of EventWithEndState objects, converts the (initial) events to a Elem. The remaining event end states are also returned in the result. The first event must be a StartElement event, or else an exception is thrown.

    The input iterator should come from a call to method convertToEventWithEndStateIterator.

    Definition Classes
    StaxEventsToYaidomConversions
  38. def toString(): String

    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ConverterToDocument[IndexedSeq[XMLEvent]]

Inherited from DocumentConverter[(XMLEventFactory) ⇒ IndexedSeq[XMLEvent]]

Inherited from ElemConverter[(XMLEventFactory) ⇒ IndexedSeq[XMLEvent]]

Inherited from AnyRef

Inherited from Any

Ungrouped