| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>XML</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XML"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/XML.html" target="_top">Frames</a></li> |
| <li><a href="XML.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.openapi.models.media</div> |
| <h2 title="Interface XML" class="title">Interface XML</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">XML</span> |
| extends <a href="../../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></pre> |
| <div class="block">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. |
| <p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc2/versions/3.0.md#xmlObject">XML Object</a> |
| </p></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#attribute-java.lang.Boolean-">attribute</a></span>(java.lang.Boolean attribute)</code> |
| <div class="block">This method sets the attribute property of XML instance to the given Boolean argument and returns the modified instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#getAttribute--">getAttribute</a></span>()</code> |
| <div class="block">This method returns the attribute property of XML instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#getName--">getName</a></span>()</code> |
| <div class="block">This method returns the name property from XML instance.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#getNamespace--">getNamespace</a></span>()</code> |
| <div class="block">This method returns the namespace property of XML instance.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#getPrefix--">getPrefix</a></span>()</code> |
| <div class="block">This method returns the prefix property of XML instance.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#getWrapped--">getWrapped</a></span>()</code> |
| <div class="block">This method returns the wrapped property of XML instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#name-java.lang.String-">name</a></span>(java.lang.String name)</code> |
| <div class="block">This method sets the name property of XML instance to the given String argument and returns the modified instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#namespace-java.lang.String-">namespace</a></span>(java.lang.String namespace)</code> |
| <div class="block">This method sets the namespace property of XML instance to the given String argument and returns the modified instance.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#prefix-java.lang.String-">prefix</a></span>(java.lang.String prefix)</code> |
| <div class="block">This method sets the prefix property of XML instance to the given String argument and returns the modified instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#setAttribute-java.lang.Boolean-">setAttribute</a></span>(java.lang.Boolean attribute)</code> |
| <div class="block">This method sets the attribute property of XML instance to the given Boolean argument.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#setName-java.lang.String-">setName</a></span>(java.lang.String name)</code> |
| <div class="block">This method sets the name property of XML instance to the given String argument.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#setNamespace-java.lang.String-">setNamespace</a></span>(java.lang.String namespace)</code> |
| <div class="block">This method sets the namespace property of XML instance to the given String argument.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#setPrefix-java.lang.String-">setPrefix</a></span>(java.lang.String prefix)</code> |
| <div class="block">This method sets the prefix property of XML instance to the given String argument.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#setWrapped-java.lang.Boolean-">setWrapped</a></span>(java.lang.Boolean wrapped)</code> |
| <div class="block">This method sets the wrapped property of XML instance to the given Boolean argument.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html#wrapped-java.lang.Boolean-">wrapped</a></span>(java.lang.Boolean wrapped)</code> |
| <div class="block">This method sets the wrapped property of XML instance to the given Boolean argument and returns the modified instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.microprofile.openapi.models.Extensible"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.microprofile.openapi.models.<a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a></h3> |
| <code><a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#addExtension-java.lang.String-java.lang.Object-">addExtension</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#getExtensions--">getExtensions</a>, <a href="../../../../../../org/eclipse/microprofile/openapi/models/Extensible.html#setExtensions-java.util.Map-">setExtensions</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block">This method returns the name property from XML instance. |
| <p> |
| The name property replaces the name of the element/attribute used for the described schema property. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>void setName(java.lang.String name)</pre> |
| <div class="block">This method sets the name property of XML instance to the given String argument. |
| <p> |
| The name property replaces the name of the element/attribute used for the described schema property. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of this XML instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="name-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> name(java.lang.String name)</pre> |
| <div class="block">This method sets the name property of XML instance to the given String argument and returns the modified instance. |
| <p> |
| The name property replaces the name of the element/attribute used for the described schema property. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of this XML instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XML instance with the set name property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNamespace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNamespace</h4> |
| <pre>java.lang.String getNamespace()</pre> |
| <div class="block">This method returns the namespace property of XML instance. |
| <p> |
| The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String namespace</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNamespace-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNamespace</h4> |
| <pre>void setNamespace(java.lang.String namespace)</pre> |
| <div class="block">This method sets the namespace property of XML instance to the given String argument. |
| <p> |
| The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - the URI of the namespace definition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="namespace-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>namespace</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> namespace(java.lang.String namespace)</pre> |
| <div class="block">This method sets the namespace property of XML instance to the given String argument and returns the modified instance. |
| <p> |
| The namespace property is the URI of the namespace definition. Value MUST be in the form of an absolute URI. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>namespace</code> - the URI of the namespace definition</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XML instance with the set namespace property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrefix--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrefix</h4> |
| <pre>java.lang.String getPrefix()</pre> |
| <div class="block">This method returns the prefix property of XML instance. |
| <p> |
| This property is a String prefix to be used for the name. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String prefix</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPrefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrefix</h4> |
| <pre>void setPrefix(java.lang.String prefix)</pre> |
| <div class="block">This method sets the prefix property of XML instance to the given String argument. |
| <p> |
| This property is a String prefix to be used for the name. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - string prefix to be used with the name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prefix-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prefix</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> prefix(java.lang.String prefix)</pre> |
| <div class="block">This method sets the prefix property of XML instance to the given String argument and returns the modified instance. |
| <p> |
| This property is a String prefix to be used for the name. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>prefix</code> - string prefix to be used with the name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XML instance with the set prefix property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttribute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre>java.lang.Boolean getAttribute()</pre> |
| <div class="block">This method returns the attribute property of XML instance. |
| <p> |
| Attribute property declares whether the property definition translates to an attribute instead of an element. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean attribute</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttribute-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>void setAttribute(java.lang.Boolean attribute)</pre> |
| <div class="block">This method sets the attribute property of XML instance to the given Boolean argument. |
| <p> |
| Attribute property declares whether the property definition translates to an attribute instead of an element. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attribute</code> - a boolean that declares whether the property definition translates to an attribute instead of an element</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="attribute-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attribute</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> attribute(java.lang.Boolean attribute)</pre> |
| <div class="block">This method sets the attribute property of XML instance to the given Boolean argument and returns the modified instance. |
| <p> |
| Attribute property declares whether the property definition translates to an attribute instead of an element. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attribute</code> - a boolean that declares whether the property definition translates to an attribute instead of an element</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XML instance with the set attribute property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWrapped--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWrapped</h4> |
| <pre>java.lang.Boolean getWrapped()</pre> |
| <div class="block">This method returns the wrapped property of XML instance. |
| <p> |
| Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition takes effect only when |
| defined alongside type being array. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Boolean wrapped</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWrapped-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWrapped</h4> |
| <pre>void setWrapped(java.lang.Boolean wrapped)</pre> |
| <div class="block">This method sets the wrapped property of XML instance to the given Boolean argument. |
| <p> |
| Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition takes effect only when |
| defined alongside type being array. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wrapped</code> - a boolean that signifies whether the array is wrapped</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wrapped-java.lang.Boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>wrapped</h4> |
| <pre><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/XML.html" title="interface in org.eclipse.microprofile.openapi.models.media">XML</a> wrapped(java.lang.Boolean wrapped)</pre> |
| <div class="block">This method sets the wrapped property of XML instance to the given Boolean argument and returns the modified instance. |
| <p> |
| Wrapped property MAY be used only for an array definition. Signifies whether the array is wrapped. The definition takes effect only when |
| defined alongside type being array. Default value is FALSE. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wrapped</code> - a boolean that signifies whether the array is wrapped</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>XML instance with the set wrapped property</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/eclipse/microprofile/openapi/models/media/Schema.SchemaType.html" title="enum in org.eclipse.microprofile.openapi.models.media"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/eclipse/microprofile/openapi/models/media/XML.html" target="_top">Frames</a></li> |
| <li><a href="XML.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |