Class StreamReader.Start

All Implemented Interfaces:
Serializable, Cloneable, Iterable<Attribute>, Collection<Attribute>, List<Attribute>, RandomAccess, SequencedCollection<Attribute>, EventNode
Enclosing class:
StreamReader

private static class StreamReader.Start extends EventElement
The Start object is used to represent the start of an XML element. This will hold the attributes associated with the element and will provide the name, the namespace reference and the namespace prefix. For debugging purposes the source XML element is provided for this start event.
  • Field Details

    • element

      private final StartElement element
      This is the start element to be used by this start event.
    • location

      private final Location location
      This is the element location used to detmine line numbers.
  • Constructor Details

    • Start

      public Start(XMLEvent event)
      Constructor for the Start object. This will wrap the provided node and expose the required details such as the name, namespace prefix and namespace reference. The provided element node can be acquired for debugging purposes.
      Parameters:
      event - this is the element being wrapped by this
  • Method Details

    • getLine

      public int getLine()
      This is used to provide the line number the XML event was encountered at within the XML document. If there is no line number available for the node then this will return a -1.
      Specified by:
      getLine in interface EventNode
      Overrides:
      getLine in class EventElement
      Returns:
      this returns the line number if it is available
    • getName

      public String getName()
      This provides the name of the event. This will be the name of an XML element the event represents. If there is a prefix associated with the element, this extracts that prefix.
      Returns:
      this returns the name without the namespace prefix
    • getPrefix

      public String getPrefix()
      This is used to acquire the namespace prefix associated with this node. A prefix is used to qualify an XML element or attribute within a namespace. So, if this represents a text event then a namespace prefix is not required.
      Returns:
      this returns the namespace prefix for this event
    • getReference

      public String getReference()
      This is used to acquire the namespace reference that this node is in. A namespace is normally associated with an XML element or attribute, so text events and element close events are not required to contain any namespace references.
      Returns:
      this will provide the associated namespace reference
    • getAttributes

      public Iterator<Attribute> getAttributes()
      This is used to acquire the attributes associated with the element. Providing the attributes in this format allows the reader to build a list of attributes for the event.
      Returns:
      this returns the attributes associated with this
    • getSource

      public Object getSource()
      This is used to return the node for the element. Because this represents a StAX event the StAX event is returned. Returning the node helps with certain debugging issues.
      Returns:
      this will return the source object for this