Package io.muserver.openapi

Class XmlObjectBuilder

  • public class XmlObjectBuilder
extends java.lang.Object
    A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information.

    • Constructor Detail

      • XmlObjectBuilder

        public XmlObjectBuilder()

    • Method Detail

      • withName

        public XmlObjectBuilder withName​(java.lang.String name)
        Parameters:
        name - Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
        Returns:
        The current builder

      • withNamespace

        public XmlObjectBuilder withNamespace​(java.net.URI namespace)
        Parameters:
        namespace - The URI of the namespace definition. Value MUST be in the form of an absolute URI.
        Returns:
        The current builder

      • withPrefix

        public XmlObjectBuilder withPrefix​(java.lang.String prefix)
        Parameters:
        prefix - The prefix to be used for the name.
        Returns:
        The current builder

      • withAttribute

        public XmlObjectBuilder withAttribute​(boolean attribute)
        Parameters:
        attribute - Declares whether the property definition translates to an attribute instead of an element. Default value is false.
        Returns:
        The current builder

      • withWrapped

        public XmlObjectBuilder withWrapped​(boolean wrapped)
        Parameters:
        wrapped - MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).
        Returns:
        The current builder

      • build

        public XmlObject build()
        Returns:
        A new object