Class: Lutaml::Xml::Listener

Inherits:

Model::Listener

• Object
• Model::Listener
• Lutaml::Xml::Listener

Defined in:

lib/lutaml/xml/listener.rb

Overview

XML-specific listener for the listener-based mapping model.

XML listeners respond to XML element names and can have custom handler blocks for complex deserialization logic.

Examples:

Adding a listener to a mapping class

class MyMapping < Lutaml::Xml::Mapping
  on_element "CustomElement" do |element, context|
    context[:custom] = CustomParser.parse(element)
  end
end

Listener with ID for override/omit support

class MyMapping < Lutaml::Xml::Mapping
  on_element "Documentation", id: :parse_docs do |element, context|
    context[:documentation] = Documentation.from_xml(element)
  end
end

Instance Attribute Summary

Attributes inherited from Model::Listener

#handler, #id, #options, #target

Instance Method Summary

• #initialize(id:, target:, handler: nil) ⇒ Listener constructor

  A new instance of Listener.

Methods inherited from Model::Listener

#call, #complex?, #eql?, #inspect, #simple?, #to_s

Constructor Details

#initialize(id:, target:, handler: nil) ⇒ Listener

Returns a new instance of Listener.

Parameters:

• id (Symbol, String, nil) —

  Unique identifier for override/omit.

• target (String) —

  XML element name this listener responds to.

• handler (Proc, nil) (defaults to: nil) —

  Custom block handler.

• options (Hash) —

  Additional options.

# File 'lib/lutaml/xml/listener.rb', line 28

def initialize(id:, target:, handler: nil, **)
  super
end