org.apache.axiom.om.impl.builder

## Interface CustomBuilderSupport

- All Known Implementing Classes:
    MTOMStAXSOAPModelBuilder, StAXBuilder, StAXOMBuilder, StAXSOAPModelBuilder, XOPAwareStAXOMBuilder

      public interface CustomBuilderSupport

  Interface allowing registration of a custom builder. This is a semi-public API used by Axis2; it is not meant for general consumption.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `CustomBuilder` | `registerCustomBuilder(QName qName, int maxDepth, CustomBuilder customBuilder)` Register a CustomBuilder associated with the indicated QName.
    `CustomBuilder` | `registerCustomBuilderForPayload(CustomBuilder customBuilder)` Register a CustomBuilder for a payload.

- - ### Method Detail

    - #### registerCustomBuilder

          CustomBuilder registerCustomBuilder(QName qName,
                                              int maxDepth,
                                              CustomBuilder customBuilder)

      Register a CustomBuilder associated with the indicated QName. The CustomBuilder will be used when an element of that qname is encountered.
      Parameters:
        `qName` -
        `maxDepth` - indicate the maximum depth that this qname will be found. (root = 0)
        `customBuilder` -
      Returns:
        replaced CustomBuilder or null

    - #### registerCustomBuilderForPayload

          CustomBuilder registerCustomBuilderForPayload(CustomBuilder customBuilder)

      Register a CustomBuilder for a payload. The payload is defined as the elements inside a SOAPBody or the document element of a REST message.
      Parameters:
        `customBuilder` -
      Returns:
        replaced CustomBuilder or null

Copyright © The Apache Software Foundation. All Rights Reserved.