Xml (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.Xml

```
@Bean(properties="name,namespace,prefix,attribute,wrapped,*")
public class Xml
extends SwaggerElement
```
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.
Example:

// Construct using SwaggerBuilder. Xml x = xml() .name("foo") .namespace("http://foo") // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "name": "foo", "namespace": "http://foo" }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

Xml()

Constructors
Constructor and Description
`Xml()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Xml`	`attribute(Object value)` Same as `setAttribute(Boolean)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`Boolean`	`getAttribute()` Bean property getter: attribute.
`String`	`getName()` Bean property getter: name.
`String`	`getNamespace()` Bean property getter: namespace.
`String`	`getPrefix()` Bean property getter: prefix.
`Boolean`	`getWrapped()` Bean property getter: wrapped.
`Xml`	`name(Object value)` Same as `setName(String)`.
`Xml`	`namespace(Object value)` Same as `setNamespace(String)`.
`Xml`	`prefix(Object value)` Same as `setPrefix(String)`.
`Xml`	`set(String property, Object value)` Generic property setter.
`Xml`	`setAttribute(Boolean value)` Bean property setter: attribute.
`Xml`	`setName(String value)` Bean property setter: name.
`Xml`	`setNamespace(String value)` Bean property setter: namespace.
`Xml`	`setPrefix(String value)` Bean property setter: prefix.
`Xml`	`setWrapped(Boolean value)` Bean property setter: wrapped.
`Xml`	`wrapped(Object value)` Same as `setWrapped(Boolean)`.

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement
getExtraProperties, isStrict, strict, strict, toString

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

- Constructor Detail
  - Xml
```
public Xml()
```
- Method Detail
  - getName
```
public String getName()
```
    Bean property getter: name.
    Replaces the name of the element/attribute used for the described schema property.
    When defined within the Items Object (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 property value, or null if it is not set.
  - setName
```
public Xml setName(String value)
```
    Bean property setter: name.
    Replaces the name of the element/attribute used for the described schema property.
    When defined within the Items Object (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.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - name
```
public Xml name(Object value)
```
    Same as setName(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getNamespace
```
public String getNamespace()
```
    Bean property getter: namespace.
    The URL of the namespace definition. Value SHOULD be in the form of a URL.
    
    Returns:
    
    The property value, or null if it is not set.
  - setNamespace
```
public Xml setNamespace(String value)
```
    Bean property setter: namespace.
    The URL of the namespace definition. Value SHOULD be in the form of a URL.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - namespace
```
public Xml namespace(Object value)
```
    Same as setNamespace(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getPrefix
```
public String getPrefix()
```
    Bean property getter: prefix.
    The prefix to be used for the name.
    
    Returns:
    
    The property value, or null if it is not set.
  - setPrefix
```
public Xml setPrefix(String value)
```
    Bean property setter: prefix.
    The prefix to be used for the name.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - prefix
```
public Xml prefix(Object value)
```
    Same as setPrefix(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getAttribute
```
public Boolean getAttribute()
```
    Bean property getter: attribute.
    Declares whether the property definition translates to an attribute instead of an element.
    
    Returns:
    
    The property value, or null if it is not set.
  - setAttribute
```
public Xml setAttribute(Boolean value)
```
    Bean property setter: attribute.
    Declares whether the property definition translates to an attribute instead of an element.
    
    Parameters:
    
    value - The new value for this property.
    Default value is false.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - attribute
```
public Xml attribute(Object value)
```
    Same as setAttribute(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Default value is false.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getWrapped
```
public Boolean getWrapped()
```
    Bean property getter: 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/>).
    The definition takes effect only when defined alongside type being array (outside the items).
    
    Returns:
    
    The property value, or null if it is not set.
  - setWrapped
```
public Xml setWrapped(Boolean value)
```
    Bean property setter: 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/>).
    The definition takes effect only when defined alongside type being array (outside the items).
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - wrapped
```
public Xml wrapped(Object value)
```
    Same as setWrapped(Boolean).
    
    Parameters:
    
    value - The new value for this property.
    Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - get
```
public <T> T get(String property,
                 Class<T> type)
```
    Description copied from class: SwaggerElement
    
    Generic property getter.
    Can be used to retrieve non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    get in class SwaggerElement
    
    Parameters:
    
    property - The property name to retrieve.
    
    type - The datatype to cast the value to.
    
    Returns:
    
    The property value, or null if the property does not exist or is not set.
  - set
```
public Xml set(String property,
               Object value)
```
    Description copied from class: SwaggerElement
    
    Generic property setter.
    Can be used to set non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    set in class SwaggerElement
    
    Parameters:
    
    property - The property name to set.
    
    value - The new value for the property.
    
    Returns:
    
    This object (for method chaining).

Class Xml

Example:

See Also:

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

Methods inherited from class java.lang.Object

Constructor Detail

Xml

Method Detail

getName

setName

name

getNamespace

setNamespace

namespace

getPrefix

setPrefix

prefix

getAttribute

setAttribute

attribute

getWrapped

setWrapped

wrapped

get

set