Class XmlEncode

java.lang.Object
ghidra.program.model.pcode.XmlEncode
All Implemented Interfaces:
Encoder

public class XmlEncode extends Object implements Encoder
An XML based encoder The underlying transfer encoding is an XML document. The encoder is initialized with a StringBuilder which will receive the XML document as calls are made on the encoder.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Clear any state associated with the encoder The encoder should be ready to write a new document after this call.
    void
    End the current element in the encoding The current element must match the given annotation or an exception is thrown.
    boolean
    The encoder is considered empty if the writeTo() method would output zero bytes
    void
    Begin a new element in the encoding The element will have the given ElementId annotation and becomes the \e current element.
     
    void
    writeBool(AttributeId attribId, boolean val)
    Write an annotated boolean value into the encoding The boolean data is associated with the given AttributeId annotation and the current open element.
    void
    writeSignedInteger(AttributeId attribId, long val)
    Write an annotated signed integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
    void
    Write an address space reference into the encoding The address space is associated with the given AttributeId annotation and the current open element.
    void
    writeString(AttributeId attribId, String val)
    Write an annotated string into the encoding The string is associated with the given AttributeId annotation and the current open element.
    void
    Dump all the accumulated bytes in this encoder to the stream.
    void
    writeUnsignedInteger(AttributeId attribId, long val)
    Write an annotated unsigned integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • XmlEncode

      public XmlEncode()
  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object
    • clear

      public void clear()
      Description copied from interface: Encoder
      Clear any state associated with the encoder The encoder should be ready to write a new document after this call.
      Specified by:
      clear in interface Encoder
    • openElement

      public void openElement(ElementId elemId) throws IOException
      Description copied from interface: Encoder
      Begin a new element in the encoding The element will have the given ElementId annotation and becomes the \e current element.
      Specified by:
      openElement in interface Encoder
      Parameters:
      elemId - is the given ElementId annotation
      Throws:
      IOException - for errors in the underlying stream
    • closeElement

      public void closeElement(ElementId elemId) throws IOException
      Description copied from interface: Encoder
      End the current element in the encoding The current element must match the given annotation or an exception is thrown.
      Specified by:
      closeElement in interface Encoder
      Parameters:
      elemId - is the given (expected) annotation for the current element
      Throws:
      IOException - for errors in the underlying stream
    • writeBool

      public void writeBool(AttributeId attribId, boolean val) throws IOException
      Description copied from interface: Encoder
      Write an annotated boolean value into the encoding The boolean data is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeBool in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is boolean value to encode
      Throws:
      IOException - for errors in the underlying stream
    • writeSignedInteger

      public void writeSignedInteger(AttributeId attribId, long val) throws IOException
      Description copied from interface: Encoder
      Write an annotated signed integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeSignedInteger in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the signed integer value to encode
      Throws:
      IOException - for errors in the underlying stream
    • writeUnsignedInteger

      public void writeUnsignedInteger(AttributeId attribId, long val) throws IOException
      Description copied from interface: Encoder
      Write an annotated unsigned integer value into the encoding The integer is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeUnsignedInteger in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the unsigned integer value to encode
      Throws:
      IOException - for errors in the underlying stream
    • writeString

      public void writeString(AttributeId attribId, String val) throws IOException
      Description copied from interface: Encoder
      Write an annotated string into the encoding The string is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeString in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      val - is the string to encode
      Throws:
      IOException - for errors in the underlying stream
    • writeSpace

      public void writeSpace(AttributeId attribId, AddressSpace spc) throws IOException
      Description copied from interface: Encoder
      Write an address space reference into the encoding The address space is associated with the given AttributeId annotation and the current open element.
      Specified by:
      writeSpace in interface Encoder
      Parameters:
      attribId - is the given AttributeId annotation
      spc - is the address space to encode
      Throws:
      IOException - for errors in the underlying stream
    • writeTo

      public void writeTo(OutputStream stream) throws IOException
      Description copied from interface: Encoder
      Dump all the accumulated bytes in this encoder to the stream.
      Specified by:
      writeTo in interface Encoder
      Parameters:
      stream - is the output stream
      Throws:
      IOException - for errors during the write operation
    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Encoder
      The encoder is considered empty if the writeTo() method would output zero bytes
      Specified by:
      isEmpty in interface Encoder
      Returns:
      true if there are no bytes in the encoder