SdtStAXHandler

java.lang.Object

org.docx4j.openpackaging.parts.StAXHandlerAbstract

org.docx4j.openpackaging.parts.WordprocessingML.SdtStAXHandler

All Implemented Interfaces:: StAXHandlerInterface

Direct Known Subclasses:: BindingTraverserStAX.StaXBindingHandler, OpenDoPEHandler.ShallowTraversorStAX

public abstract class SdtStAXHandler extends StAXHandlerAbstract

A framework for using StAX to find SDT elements, then using JAXB to manipulate them.

Since:: 11.5.3

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

SdtStAXHandler.Stack
Field Summary

Fields

Modifier and Type

Field

Description

static jakarta.xml.bind.JAXBContext

context

private static org.slf4j.Logger

log

protected SdtStAXHandler.Stack

stack
Constructor Summary

Constructors

Constructor

Description

SdtStAXHandler()
Method Summary

Modifier and Type

Method

Description

void

handle(XMLStreamReader xsr, XMLStreamWriter xmlWriter)

void

handleCharacters(XMLStreamReader xmlr, XMLStreamWriter writer)

Implement this method; for an example, see VariableReplaceStAX sample

protected abstract List<Object>

handleSdt(SdtElement sdt)

Manipulate the SDT as you wish.

Methods inherited from class org.docx4j.openpackaging.parts.StAXHandlerAbstract
write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- log
  
  private static org.slf4j.Logger log
- context
  
  public static jakarta.xml.bind.JAXBContext context
- stack
  
  protected SdtStAXHandler.Stack stack
Constructor Details
- SdtStAXHandler
  
  public SdtStAXHandler()
Method Details
- handleSdt
  
  protected abstract List<Object> handleSdt(SdtElement sdt) throws Docx4JException
  
  Manipulate the SDT as you wish.
  
  Parameters:
  
  sdt -
  
  Throws:
  
  Docx4JException
- handle
  
  public void handle(XMLStreamReader xsr, XMLStreamWriter xmlWriter) throws LocationAwareXMLStreamException, XMLStreamException
  
  Specified by:
  
  handle in interface StAXHandlerInterface
  
  Overrides:
  
  handle in class StAXHandlerAbstract
  
  Throws:
  
  LocationAwareXMLStreamException
  
  XMLStreamException
- handleCharacters
  
  public void handleCharacters(XMLStreamReader xmlr, XMLStreamWriter writer) throws XMLStreamException
  
  Description copied from class: StAXHandlerAbstract
  
  Implement this method; for an example, see VariableReplaceStAX sample
  
  Specified by:
  
  handleCharacters in class StAXHandlerAbstract
  
  Throws:
  
  XMLStreamException