Module tools.jackson.dataformat.xml
Package tools.jackson.dataformat.xml.ser

Record Class RootAttribute

java.lang.Object
java.lang.Record
tools.jackson.dataformat.xml.ser.RootAttribute
All Implemented Interfaces:
XmlGeneratorWritable
public record RootAttribute(QName name, String value) extends Record implements XmlGeneratorWritable
Value container to represent an attribute to add to the root XML element being written, to be registered via XmlGeneratorInitializer.addRootAttribute(QName, String) (or its String-name overload).

Typical use case is adding XML Schema instance attributes such as xsi:schemaLocation or xsi:noNamespaceSchemaLocation, but any attribute can be added.

NOTE: root attributes are only emitted when the root value being serialized produces a structured (object) start element; scalar root values (e.g. a bare String) do not currently get root attributes attached.

Since:
3.2

  • Constructor Summary

    Constructors
    Constructor
    Description
    RootAttribute(QName name, String value)
    Creates an instance of a RootAttribute record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    QName
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    Returns the value of the value record component.
    void
    write(ToXmlGenerator xmlGen, org.codehaus.stax2.XMLStreamWriter2 sw)
    Method to call to actually write out the entity using given XMLStreamWriter2.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RootAttribute

      public RootAttribute(QName name, String value)
      Creates an instance of a RootAttribute record class.
      Parameters:
      name - the value for the name record component
      value - the value for the value record component

  • Method Details

    • write

      public void write(ToXmlGenerator xmlGen, org.codehaus.stax2.XMLStreamWriter2 sw) throws XMLStreamException
      Description copied from interface: XmlGeneratorWritable
      Method to call to actually write out the entity using given XMLStreamWriter2. ToXmlGenerator is only passed in case access to configuration was needed.
      Specified by:
      write in interface XmlGeneratorWritable
      Parameters:
      xmlGen - Generator that called this method: MUST NOT call its output methods, only to be used for configuration access
      sw - Writer to use for actual output of XML event
      Throws:
      XMLStreamException

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public QName name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • value

      public String value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component