Package com.asyncapi.schemas.openapi.v3._0_0.properties

Class XML

java.lang.Object

com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

com.asyncapi.schemas.openapi.v3._0_0.properties.XML

public class XML
extends Extensions

XML

Version:

3.0.0

Author:

Pavel Bodiachevskii

See Also:

• XML Object
• XML

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	attribute	Declares whether the property definition translates to an attribute instead of an element.
@Nullable String	name	Replaces the name of the element/attribute used for the described schema property.
String	namespace	The URI of the namespace definition.
String	prefix	The prefix to be used for the name.
Boolean	wrapped	MAY be used only for an array definition.

Fields inherited from class com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

extensions

Constructor Summary

Constructors

Constructor	Description
XML()

Method Summary

Methods inherited from class com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

readExtensionProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

@Nullable
@JsonPropertyDescription("Replaces the name of the element/attribute used for the described schema property.")
public @Nullable String 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.

See Also:

• XML Fixed Fields: name

namespace

public String namespace

The URI of the namespace definition.

Value MUST be in the form of an absolute URI.

See Also:

• XML Fixed Fields: namespace

prefix

public String prefix

The prefix to be used for the name.

See Also:

• XML Fixed Fields: prefix

attribute

public Boolean attribute

Declares whether the property definition translates to an attribute instead of an element.

Default value is false.

See Also:

• XML Fixed Fields: attribute

wrapped

public Boolean wrapped

MAY be used only for an array definition.

Signifies whether the array is wrapped:

 <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).

See Also:

• XML Fixed Fields: wrapped

Constructor Details

XML

public XML()